API ReferenceapicommsOverview

comms

82 endpoints · OpenAPI spec: services/comms/openapi.yaml · Service detail

Endpoints

MethodPathSummary
GET/readyzGET /readyz
POST/v1/account-export-linkPOST /v1/account-export-link
GET/v1/admin/ask/coach-sla-overdueGET /v1/admin/ask/coach-sla-overdue
GET/v1/admin/campaignsGET /v1/admin/campaigns
POST/v1/admin/campaignsPOST /v1/admin/campaigns
GET/v1/admin/campaigns/\{id\}GET /v1/admin/campaigns/{id}
PATCH/v1/admin/campaigns/\{id\}PATCH /v1/admin/campaigns/{id}
POST/v1/admin/campaigns/\{id\}/cancelPOST /v1/admin/campaigns/{id}/cancel
GET/v1/admin/campaigns/\{id\}/historyGET /v1/admin/campaigns/{id}/history
POST/v1/admin/campaigns/\{id\}/schedulePOST /v1/admin/campaigns/{id}/schedule
POST/v1/admin/campaigns/\{id\}/sendPOST /v1/admin/campaigns/{id}/send
POST/v1/admin/campaigns/process-batchPOST /v1/admin/campaigns/process-batch
POST/v1/admin/digests/send-communityPOST /v1/admin/digests/send-community
POST/v1/admin/digests/send-nightlyPOST /v1/admin/digests/send-nightly
POST/v1/admin/dunning/send-remindersPOST /v1/admin/dunning/send-reminders
POST/v1/admin/emails/send-stuck-checkoutPOST /v1/admin/emails/send-stuck-checkout
POST/v1/admin/erasurePOST /v1/admin/erasure
POST/v1/admin/inbox/screening-statusPOST /v1/admin/inbox/screening-status
POST/v1/admin/notificationsPOST /v1/admin/notifications
POST/v1/admin/notifications/send-payoutPOST /v1/admin/notifications/send-payout
POST/v1/admin/notifications/send-salePOST /v1/admin/notifications/send-sale
POST/v1/admin/nudges/send-signupPOST /v1/admin/nudges/send-signup
POST/v1/admin/reminders/send-dosePOST /v1/admin/reminders/send-dose
POST/v1/admin/sla/sms-pingPOST /v1/admin/sla/sms-ping
POST/v1/admin/sync/affiliate-phones-klaviyoPOST /v1/admin/sync/affiliate-phones-klaviyo
POST/v1/admin/sync/klaviyo-cross-accountPOST /v1/admin/sync/klaviyo-cross-account
POST/v1/admin/sync/profiles-to-klaviyoPOST /v1/admin/sync/profiles-to-klaviyo
GET/v1/ask/threadsGET /v1/ask/threads
POST/v1/ask/threadsPOST /v1/ask/threads
GET/v1/ask/threads/\{thread_id\}GET /v1/ask/threads/{thread_id}
POST/v1/ask/threads/\{thread_id\}/repliesPOST /v1/ask/threads/{thread_id}/replies
GET/v1/attachments/\{id\}/download-urlGET /v1/attachments/{id}/download-url
PUT/v1/consentsPUT /v1/consents
GET/v1/consents/\{person_id\}GET /v1/consents/{person_id}
PATCH/v1/inbox/\{id\}/readPATCH /v1/inbox/{id}/read
GET/v1/inbox/\{person_id\}GET /v1/inbox/{person_id}
POST/v1/inbox/\{user_id\}/bulk-archivePOST /v1/inbox/{user_id}/bulk-archive
POST/v1/inbox/\{user_id\}/bulk-readPOST /v1/inbox/{user_id}/bulk-read
GET/v1/inbox/\{user_id\}/unread-countGET /v1/inbox/{user_id}/unread-count
GET/v1/messages/\{id\}GET /v1/messages/{id}
GET/v1/messages/recentGET /v1/messages/recent
POST/v1/messages/schedulePOST /v1/messages/schedule
GET/v1/messages/scheduledGET /v1/messages/scheduled
GET/v1/messages/scheduled/\{id\}GET /v1/messages/scheduled/{id}
POST/v1/messages/scheduled/\{id\}/cancelPOST /v1/messages/scheduled/{id}/cancel
POST/v1/messages/sendPOST /v1/messages/send
GET/v1/notificationsGET /v1/notifications
POST/v1/notifications/\{id\}/readPOST /v1/notifications/{id}/read
POST/v1/notifications/read-allPOST /v1/notifications/read-all
GET/v1/notifications/unread-countGET /v1/notifications/unread-count
PUT/v1/preferencesPUT /v1/preferences
GET/v1/preferences/\{person_id\}GET /v1/preferences/{person_id}
POST/v1/push/sendPOST /v1/push/send
POST/v1/push/subscriptionsPOST /v1/push/subscriptions
DELETE/v1/push/subscriptions/\{id\}DELETE /v1/push/subscriptions/{id}
GET/v1/push/subscriptions/\{person_id\}GET /v1/push/subscriptions/{person_id}
DELETE/v1/push/subscriptions/by-endpoint/\{endpoint\}DELETE /v1/push/subscriptions/by-endpoint/{endpoint}
GET/v1/push/vapid-keyGET /v1/push/vapid-key
POST/v1/resubscribePOST /v1/resubscribe
GET/v1/sequencesGET /v1/sequences
POST/v1/sequencesPOST /v1/sequences
GET/v1/sequences/\{id\}GET /v1/sequences/{id}
POST/v1/sequences/\{id\}/enrollPOST /v1/sequences/{id}/enroll
GET/v1/sequences/\{id\}/enrollmentsGET /v1/sequences/{id}/enrollments
POST/v1/sequences/\{id\}/pausePOST /v1/sequences/{id}/pause
POST/v1/sequences/\{id\}/resumePOST /v1/sequences/{id}/resume
POST/v1/sequences/enrollments/\{id\}/cancelPOST /v1/sequences/enrollments/{id}/cancel
POST/v1/slack/commands/smsPOST /v1/slack/commands/sms
POST/v1/slack/eventsPOST /v1/slack/events
POST/v1/slack/interactPOST /v1/slack/interact
GET/v1/stream/chat-tokenGET /v1/stream/chat-token
POST/v1/stream/feeds-tokenPOST /v1/stream/feeds-token
POST/v1/support/ticketsPOST /v1/support/tickets
POST/v1/suppressionsPOST /v1/suppressions
GET/v1/suppressions/\{email\}GET /v1/suppressions/{email}
DELETE/v1/suppressions/\{id\}DELETE /v1/suppressions/{id}
GET/v1/threadsGET /v1/threads
POST/v1/threadsPOST /v1/threads
GET/v1/threads/\{id\}GET /v1/threads/{id}
POST/v1/threads/\{threadId\}/attachmentsPOST /v1/threads/{threadId}/attachments
POST/v1/unsubscribePOST /v1/unsubscribe
POST/v1/webhooks/emailPOST /v1/webhooks/email