Skip to main content

SemaswiftDocs

Auth API
Billing API
Voice API
Ticketing API
Engagements API
Uploads API
Automation API
Notifications API
Reports API
Surveys API
CRM API

Introduction
CreateStatusConfig creates a new custom status configuration.
DeleteStatusConfig deletes a custom status configuration.
GetAvailableAgents retrieves all currently available agents.
GetCurrentStatus retrieves any agent's current status.
GetMyStatistics retrieves the authenticated agent's status statistics.
GetMyStatusHistory retrieves the authenticated agent's status history.
GetMyStatus retrieves the authenticated agent's current status.
GetStatistics retrieves any agent's status statistics.
GetStatusConfig retrieves a specific status configuration.
GetStatusHistory retrieves any agent's status history.
ListStatusConfigs lists all status configurations.
SetAgentStatus sets any agent's current status (admin only).
SetMyStatus sets the authenticated agent's current status.
UpdateStatusConfig updates an existing status configuration.
CreateAttachment creates a new attachment.
DeleteAttachment deletes an attachment.
GetAttachment retrieves an attachment by ID.
ListAttachments retrieves attachments for a message.
UpdateAttachment updates an attachment.
CreateChannelConfig creates a new channel configuration.
DeleteChannelConfig removes a channel configuration.
GetAutoReplySettings retrieves auto-reply settings for a channel.
GetAvailabilitySettings returns the availability-related settings for a channel config. This is a lightweight, internal RPC used by the ticketing service's `ChannelConfigClient` to resolve a channel's `is_24_7_available` flag and default `availability_calendar_id` without loading full credentials or permission-sensitive fields.
GetChannelConfig retrieves a channel configuration.
GetChannel retrieves a single channel definition.
ListChannelConfigs lists organization's configurations.
ListChannels lists all available messaging platforms.
SyncChannelConfig syncs data with platform.
TestAutoReply sends a test auto-reply message.
UpdateAutoReplySettings updates auto-reply settings for a channel.
UpdateChannelConfig updates a channel configuration.
VerifyChannelConfig tests a channel configuration.
CreateContactRole creates a new contact role for the organization.
CreateContactStage creates a new contact stage for the organization.
CreateContactType creates a new contact type for the organization.
CreateDepartment creates a new department for the organization.
CreateGroup creates a new contact group for the organization.
CreateLineOfBusiness creates a new line of business for the organization.
DeleteContactRole deletes a contact role.
DeleteContactStage deletes a contact stage.
DeleteContactType deletes a contact type.
DeleteDepartment deletes a department.
DeleteGroup deletes a contact group.
DeleteLineOfBusiness deletes a line of business.
ListCities lists cities, optionally filtered by country.
ListContactRoles lists contact roles for the organization.
ListContactStages lists contact stages for the organization.
ListContactTypes lists contact types for the organization.
ListCountries lists all available countries.
ListDepartments lists departments for the organization.
ListGroups lists contact groups for the organization.
ListIndustries lists all available industries.
ListLinesOfBusiness lists lines of business for the organization.
UpdateContactRole updates a contact role.
UpdateContactStage updates a contact stage.
UpdateContactType updates a contact type.
UpdateDepartment updates a department.
UpdateGroup updates a contact group.
UpdateLineOfBusiness updates a line of business.
CreateContact creates a new customer contact.
DeleteContact removes a contact.
GetContact retrieves a contact by ID.
GetStageHistory retrieves stage change history.
ListContacts lists contacts with filtering and pagination.
SearchContact finds a contact by phone or email.
UpdateContact modifies an existing contact.
UpdateStage changes a contact's pipeline stage.
ConfigureWebhook sets up or updates webhook configuration.
DisconnectEmail disconnects the email integration.
GetDNSRecords retrieves required DNS records for a domain.
GetEmailDomainConfig retrieves email domain configuration.
GetEmailSettings retrieves email-specific settings.
SetupEmailDomain initiates email domain configuration.
TestEmailConfig sends a test email.
UpdateEmailDomainConfig updates email domain sender settings.
UpdateEmailSettings updates email-specific settings.
VerifyEmailDomain checks DNS configuration for custom domains.
CreateEscalationPolicy creates a new escalation policy.
CreateEscalationRule creates a new escalation rule within a policy.
DeleteEscalationPolicy deletes an escalation policy.
DeleteEscalationRule deletes an escalation rule.
GetEscalationHistory retrieves escalation history for an engagement.
GetEscalationPolicy retrieves an escalation policy by ID.
GetEscalationRule retrieves an escalation rule by ID.
ListEscalationHistory lists escalation history for an organization.
ListEscalationPolicies lists all escalation policies for an organization.
UpdateEscalationPolicy updates an escalation policy.
UpdateEscalationRule updates an escalation rule.
AssignEngagement assigns an engagement to an agent.
BulkUpdateEngagements updates multiple engagements.
CloseEngagement closes an engagement with outcome.
CreateEngagement creates a new customer engagement.
DeleteEngagement removes an engagement.
EscalateToTicket escalates an engagement to a ticket.
GenerateEngagementSummary triggers AI summary generation.
GetContactTimeline retrieves timeline events across all engagements for a contact.
GetEngagementByExternalId finds engagement by platform ID.
GetEngagementBySource finds engagement by source reference.
GetEngagementStats retrieves engagement statistics by channel and status.
GetEngagementTimeline retrieves activity history.
GetEngagement retrieves a single engagement by ID.
GetInbox retrieves the agent's inbox with all data needed for display.
ListEngagements retrieves engagements matching filters.
MergeEngagements combines multiple engagements.
ReopenEngagement reopens a closed engagement.
SelfAssignEngagement allows an agent to assign an engagement to themselves.
TransferEngagement transfers engagement between agents.
UpdateEngagement modifies an existing engagement.
GetEngagementSettings retrieves current settings.
UpdateEngagementSettings updates settings.
CreateSLAPolicy creates a new SLA policy.
DeleteSLAPolicy deletes an SLA policy.
GetEngagementSLA retrieves the SLA status for a specific engagement.
GetSLAPolicy retrieves an SLA policy by ID.
ListSLABreaches lists SLA breaches for an organization.
ListSLAPolicies lists all SLA policies for an organization.
PauseSLA pauses SLA tracking for an engagement.
ResumeSLA resumes SLA tracking for an engagement.
UpdateSLAPolicy updates an SLA policy.
OAuth2 Flow - Complete OAuth and get available pages
Disconnect - Soft delete channel configuration
Get page status and health info
OAuth2 Flow - Initiate OAuth to connect Facebook Page
Select a page from the OAuth session to connect
Manual Configuration - Verify credentials and create channel config
GetFormSubmission retrieves a single form submission.
ListFormSubmissions lists form submissions for the organization.
ProcessFormSubmission processes a form submission.
SubmitForm creates a new form submission.
OAuth2 Flow - Complete OAuth and get available Instagram accounts
Disconnect - Soft delete channel configuration
Get account status and health info
OAuth2 Flow - Initiate OAuth to connect Instagram Business Account
Select an Instagram account from the OAuth session to connect
Manual Configuration - Verify credentials and create channel config
BulkMarkAsRead marks multiple messages as read.
CreateMessage creates a message in an engagement.
DeleteMessage removes a message.
GetMessageByExternalId finds message by platform ID.
GetMessageThread retrieves a message thread.
GetMessage retrieves a single message by ID.
GetUnreadCount retrieves total unread count for current user.
GetUnreadCountsByEngagement retrieves unread counts per engagement.
ListMessages retrieves messages for an engagement.
MarkEngagementAsRead marks all messages in engagement as read.
MarkMessageAsRead marks a message as read.
RetryFailedMessage retries delivery of a failed message.
Declared before the {id} wildcard sibling below: mux matches in registration order, and the generator emits registrations in declaration order, so a wildcard declared first swallows every literal after it. SearchMessages searches message content.
SendMessage creates and sends a message via channel.
UpdateMessage modifies an existing message.
Verifies a Meta webhook HMAC signature against the org-owning channel config and returns the resolved org plus validity. mTLS-only; called by the auth service during proof validation.
CreateOutcome creates a new outcome.
DeleteOutcome deletes an outcome.
GetOutcome retrieves an outcome by ID.
ListOutcomes lists all outcomes.
UpdateOutcome updates an outcome.
BulkAddParticipants adds multiple participants.
CreateParticipant adds a participant to an engagement.
DeleteParticipant removes a participant record.
GetParticipant retrieves a participant by ID.
ListParticipants retrieves engagement participants.
RemoveParticipant marks a participant as left.
TransferOwnership transfers engagement ownership.
UpdateParticipant updates a participant.
GetAgentTokens generates Centrifugo tokens for an authenticated agent.
GetEngagementToken generates a subscription token for a specific engagement.
GetEngagementTokens generates subscription tokens for multiple engagements in a single round trip.
GetPresence retrieves presence status for specified agents.
GetQueueToken generates a subscription token for a voice queue channel.
GetQueueTokens generates subscription tokens for multiple voice queues.
GetVisitorTokens generates Centrifugo tokens for a webchat visitor.
Heartbeat extends the authenticated agent's presence TTL.
MarkAsRead marks messages in an engagement as read.
RefreshRealtimeToken issues a fresh Centrifugo connection token before the current one expires.
StartTyping notifies participants that the user started typing.
StopTyping notifies participants that the user stopped typing.
UpdatePresence updates the authenticated agent's presence status.
GetAgentCapacity retrieves an agent's capacity.
GetAvailableAgentsForQueue retrieves available agents for a queue.
GetRoutingHistory retrieves routing history for an engagement.
RouteEngagement routes an engagement to an appropriate agent.
UpdateAgentCapacity updates an agent's capacity settings.
AddQueueMember adds a member to a queue.
AddRequiredSkill adds a skill requirement to a queue.
CreateQueue creates a new routing queue.
DeleteQueue deletes a queue.
GetAssignableAgents returns agents that can be assigned to a queue.
GetQueueStats retrieves queue statistics.
GetQueue retrieves a queue by ID.
ListQueueMembers lists all members of a queue.
ListQueues lists all queues for an organization.
RemoveQueueMember removes a member from a queue.
RemoveRequiredSkill removes a skill requirement from a queue.
UpdateQueueMember updates a queue member's settings.
UpdateQueue updates a queue.
CreateRule creates a new routing rule.
DeleteRule deletes a rule.
GetRule retrieves a rule by ID.
ListRules lists all rules for an organization.
UpdateRule updates a rule.
AssignSkillToAgent assigns a skill to an agent.
CreateSkill creates a new routing skill.
DeleteSkill deletes a skill.
GetSkill retrieves a skill by ID.
ListAgentSkills lists all skills for an agent.
ListSkills lists all skills for an organization.
RemoveSkillFromAgent removes a skill from an agent.
UpdateAgentSkill updates an agent's skill proficiency.
UpdateSkill updates a skill.
SocialCommentService_DeleteComment
SocialCommentService_HideComment
SocialCommentService_IgnoreComment
SocialCommentService_ListComments
SocialCommentService_ReplyPrivate
SocialCommentService_ReplyPublic
BulkApplyTags applies tags to multiple engagements.
CreateTag creates a new tag.
DeleteTag deletes a tag.
Declared before the {id} wildcard sibling below: mux matches in registration order, and the generator emits registrations in declaration order, so a wildcard declared first swallows every literal after it. GetPopularTags retrieves most used tags.
GetTag retrieves a tag by ID.
ListTags lists tags.
RemoveTagsFromEngagement removes tags from an engagement.
UpdateTag updates a tag.
CreateMetaTemplate submits a new template to Meta for review.
CreateTemplate creates a new template.
DeleteMetaTemplate removes a Meta-approved template from Meta and locally.
DeleteTemplate deletes a template.
GetTemplateByShortcut finds a template by its shortcut.
GetTemplate retrieves a template by ID.
ListTemplates lists templates.
PreviewTemplate resolves variables for a WhatsApp template.
RenderTemplate renders a template with variable values.
SyncTemplates fetches all templates from Meta and updates local cache.
UpdateTemplate updates a template.
CreateTopic creates a new topic.
DeleteTopic deletes a topic.
GetTopic retrieves a topic by ID.
ListTopics lists topics.
UpdateTopic updates a topic.
NotifyVisitorConnected cancels any pending disconnect timer for the visitor. Called when Centrifugo's `connect` proxy webhook fires for a visitor that already had a debounce pending (i.e. they reconnected within the 2 minute grace window).
NotifyVisitorDisconnected schedules a `visitor.disconnected` engagement event to be published in 2 minutes if the visitor does not reconnect (cancelled by NotifyVisitorConnected on a fresh connect).
CreateOfflineMessage creates a message when team is offline.
CreateWidgetConfig creates webchat widget configuration.
DeleteWidgetConfig deletes a webchat widget configuration.
GenerateSnippet generates JavaScript embed snippet.
GetEngagementRating retrieves the rating for a specific engagement.
GetVisitorByVisitorID retrieves visitor by client-generated ID.
GetVisitor retrieves a visitor by ID.
GetWidgetConfig retrieves webchat widget configuration.
GetWidgetStatus checks if team is online.
LinkVisitorToContact links a webchat visitor to a contact record.
ListEngagementRatings lists ratings with optional filters.
ListOfflineMessages lists offline messages.
ListVisitors lists webchat visitors with filtering.
ListWidgetConfigs lists all widget configurations for the organization.
ProcessOfflineMessage processes an offline message.
RegenerateWidgetKey regenerates the widget key for a configuration.
SendChatTranscript emails conversation transcript.
SubmitEngagementRating submits a satisfaction rating for an engagement.
UpdateWidgetConfig updates webchat widget configuration.
CompleteOAuth2 processes OAuth2 code submitted by the frontend.
DisconnectWhatsApp deactivates a WhatsApp channel configuration.
GetPhoneNumberStatus retrieves phone number health and quality.
GetWhatsAppBusinessAccount retrieves a single WABA by ID.
HandleEmbeddedSignupCallback processes the Embedded Signup callback.
HandleOAuth2Callback processes the OAuth2 callback from Meta.
HandleOAuthCallback processes the OAuth callback from Meta. Deprecated: Use HandleOAuth2Callback or HandleEmbeddedSignupCallback instead.
InitiateConnect starts the Meta Embedded Signup OAuth flow. Deprecated: Use InitiateOAuth2 or InitiateEmbeddedSignup instead.
InitiateEmbeddedSignup starts Meta's Embedded Signup flow.
InitiateOAuth2 starts the OAuth2 flow to connect an existing WABA.
LinkPhoneNumbers creates channel configs for selected phone numbers.
ListWhatsAppBusinessAccounts lists the organization's WABAs.
ReauthorizeWhatsApp replaces the stored credentials of an existing WABA.
VerifyCredentials validates and creates a WhatsApp configuration.

GetOutcome retrieves an outcome by ID.

GetOutcome retrieves an outcome by ID.

GET /api/v1/engagements/settings/outcomes/:id

Errors

NOT_FOUND: Outcome does not exist

Request

Responses

200
default

A successful response.

An unexpected error response.

DeleteOutcome deletes an outcome.

ListOutcomes lists all outcomes.

Documentation

Getting Started
Authentication
API Reference

API Services

Auth API
Billing API
Voice API
Ticketing API
Reports API
Notifications API
Surveys API
CRM API

More

Changelog
GitHub
Support

Copyright © 2026 Semaswift. All rights reserved.