Authentication
Operations
AccountSecrets
get
getCurrentAccountSecret
Accounts
post
create
post
createAccountWithNewAdmin
del
delete
get
getByName
get
getCurrentAccount
get
isAccountNameAvailable
get
read
post
readMultiple
post
search
post
update
Addresses
post
create
del
delete
get
read
post
readMultiple
post
search
post
update
ApiKeys
post
create
del
delete
get
getByKey
get
getDefaultForAccountId
get
getQuotaUsage
get
read
post
readMultiple
post
search
post
update
Authenticator
get
authenticateWithToken
post
changePassword
post
checkPasswordAgainstPolicy
get
checkSuperAdminPasswordFile
post
createAuthenticationToken
post
createAuthenticationTokenForCurrentUser
get
getAuthenticatedUserDisplayName
get
getAuthenticatedUserName
get
getCompactUser
get
getUserId
get
getUserPermissions
get
getUserRole
post
impersonate
get
isAuthenticated
get
isRegisteredUser
get
isSuperAdmin
post
login
post
loginWithSecureToken
post
logout
post
resetImpersonation
post
sendPasswordResetMail
post
setDefaultLocale
post
setNewPassword
post
switchToAccount
Availability
get
getAgentAvailability
Avatars
post
create
get
read
Bots
post
acceptDialogOffer
post
cancelPendingDialogQuestions
post
cancelPendingQuestion
post
create
post
declineDialogOffer
del
delete
post
dialogMessageDelivered
post
dialogMessageRead
post
finishDialog
get
getByName
post
pingWebhook
get
read
post
search
post
sendDialogMessage
post
sendMessage
post
update
CannedResponses
post
create
del
delete
get
getCannedResponsesAvailableForChat
get
getWritableConfigurationScopes
get
getWritableConfigurationScopesAvailableForChat
get
read
post
readMultiple
post
search
post
update
Contacts
post
create
del
delete
get
read
post
readMultiple
post
search
post
update
ConversationHistory
get
read
post
search
post
searchMessages
ConversationTemplates
post
create
del
delete
get
getDefaultTemplateByEngagementType
get
read
post
readMultiple
post
search
post
update
Conversations
post
addParticipant
post
changeParticipantVisibility
post
create
del
delete
post
end
get
getBySourceIdAndChannelId
get
getConversationFiles
post
offboardParticipant
get
read
post
search
post
setAssigneePerson
post
setContextPerson
post
setLocale
post
setRecipient
post
setStarred
post
setVisitorData
post
updateConfiguration
post
updateMetadata
post
updateText
Domains
post
create
del
delete
get
getAccountDomainsAsString
get
getQuotaUsage
get
read
post
readMultiple
post
search
post
update
ExternalMessengers
post
create
del
delete
get
getByName
post
messageDelivered
post
messageRead
post
messageSendFailed
post
messageSentSuccessfully
post
pingCustomChannel
get
read
post
search
post
sendMessage
post
update
Global
post
installLicense
get
productVersion
get
read
post
update
Invitations
post
forwardConversationToAgent
post
forwardConversationToTeam
post
inviteAgentToConversation
post
inviteAnonymousVisitorToConversationWithEmail
post
inviteAnonymousVisitorToConversationWithLink
post
inviteAnonymousVisitorToConversationWithPin
post
inviteTeamToConversation
post
renewPin
post
requeueConversation
post
revoke
post
search
NamedAreas
post
create
del
delete
get
getQuotaUsage
get
read
post
readMultiple
post
search
post
update
PersonPresences
get
read
post
search
Persons
post
createOrUpdateBot
post
createOrUpdateVirtual
get
getBySource
get
read
post
search
Services
get
findWebhookEventTypeNamesBy
get
getAllServiceNames
get
getAllServices
get
getAllServicesMetadata
get
getAllTypeNames
get
getAllTypes
get
getAllWebhookEventTypeNames
get
getAllWebhookEventTypes
get
getServiceByName
get
getTypeByName
get
getWebhookEventTypeByName
Teams
post
create
del
delete
get
getByParentId
get
getChildTeamIds
get
getChildTeams
get
getQuotaUsage
get
getTeamOfCurrentUser
get
read
post
readMultiple
post
search
get
teamIsChildOfOtherTeam
post
update
Users
post
create
post
createUserWithRandomPassword
post
createWithPassword
del
delete
get
doesUserLoginExist
get
getByUsername
get
getQuotaUsage
get
isSuperUser
get
isUsernameAvailable
get
read
post
readMultiple
post
search
post
update
post
updateAndRemovePassword
post
updatePassword
post
updateUserWithRandomPassword
post
updateWithPassword
get
userHasPassword
WebhookCallLogs
get
read
post
readMultiple
post
search
WebhookRegistrations
post
create
del
delete
get
getByName
post
ping
get
read
post
readMultiple
post
search
post
update
Webhook events
For bots
bot.dialog.closed
bot.dialog.counterpart_changed
bot.dialog.message
bot.dialog.message_state
bot.dialog.opened
bot.offboarding_offer
bot.onboarding_offer
bot.reboarding_offer
For external messengers
external_messenger.message_state
external_messenger.new_message
For webhooks
account
agent_forwarding.created
agent_forwarding.redeemed
agent_forwarding.revoked
agent_invitation.created
agent_invitation.redeemed
agent_invitation.revoked
api_key
assignment_request.created
assignment_request.redeemed
assignment_request.revoked
conversation.created
conversation.ended
conversation.message_state
conversation.new_message
conversation.updated
domain
named_area
person
pin.created
pin.redeemed
pin.renewed
pin.revoked
ping
push_notification.incoming_call
push_notification.missed_call
push_notification.new_message
push_notification.read_message
push_notification.revoke_call
team
user
visitor_invitation.created
visitor_invitation.redeemed
visitor_invitation.renewed
visitor_invitation.revoked
Schemas
Schemas
Account
AccountData
AccountModificationEvent
AccountOrderBy
AccountQuery
AccountResult
AccountSearchFilter
AccountSecret
AccountUserContainer
Address
AddressOrderBy
AddressQuery
AddressResult
AddressSearchFilter
AgentForwardingCreatedEvent
AgentForwardingRedeemedEvent
AgentForwardingRevokedEvent
AgentInvitationCreatedEvent
AgentInvitationRedeemedEvent
AgentInvitationRevokedEvent
AgentTargetData
AllEqualIdListOperator
AllOfIdListOperator
AnyOfIdListOperator
ApiKey
ApiKeyApiKeySearchFilter
ApiKeyModificationEvent
ApiKeyOrderBy
ApiKeyQuery
ApiKeyResult
ApiKeySearchFilter
ApprovalRequestMessageData
ArrayBody
AssigneePersonIdConversationSearchFilter
AssignmentRequestCreatedEvent
AssignmentRequestRedeemedEvent
AssignmentRequestRevokedEvent
AuthenticatorChangePasswordBody
AuthenticatorCheckPasswordAgainstPolicyBody
AuthenticatorCreateAuthenticationTokenBody
AuthenticatorImpersonateBody
AuthenticatorLoginBody
AuthenticatorLogoutBody
AuthenticatorResetImpersonationBody
AuthenticatorSendPasswordResetMailBody
AuthenticatorSetDefaultLocaleBody
AuthenticatorSetNewPasswordBody
AuthenticatorSwitchToAccountBody
AuthorizationRoleOperator
AuthorizationRolePersonSearchFilter
AuthorizationRoleUserSearchFilter
Avatar
BodyElement
BooleanOperator
BotDialogClosedEvent
BotDialogCounterpartChanged
BotDialogMessageEvent
BotDialogMessageStateEvent
BotDialogOpenEvent
BotDialogPostMessage
BotOffboardingOfferEvent
BotOnboardingOfferEvent
BotPostMessage
BotReboardingOfferEvent
BotsAcceptDialogOfferBody
BotsCancelPendingDialogQuestionsBody
BotsCancelPendingQuestionBody
BotsDeclineDialogOfferBody
BotsDialogMessageDeliveredBody
BotsDialogMessageReadBody
BotsFinishDialogBody
BotsPingWebhookBody
CannedResponse
CannedResponseConfigurationScope
CannedResponseOrderBy
CannedResponseQuery
CannedResponseResult
CannedResponseSearchFilter
CardMessageData
CardPostMessageData
CompactUser
Contact
ContactOrderBy
ContactQuery
ContactResult
ContactSearchFilter
ContainsStringOperator
ContextPersonIdConversationSearchFilter
ContextPersonInfo
ConversationCreatedEvent
ConversationData
ConversationEndReasonOperator
ConversationEndedEvent
ConversationFileData
ConversationHistoryData
ConversationHistoryMessageData
ConversationIdConversationInvitationSearchFilter
ConversationInvitationData
ConversationInvitationOrderBy
ConversationInvitationQuery
ConversationInvitationResult
ConversationInvitationSearchFilter
ConversationLink
ConversationMessageStateEvent
ConversationNewMessageEvent
ConversationOrderBy
ConversationQuery
ConversationRecipientData
ConversationRecipientTypeOperator
ConversationResult
ConversationSearchFilter
ConversationStateOperator
ConversationTemplate
ConversationTemplateIdConversationSearchFilter
ConversationTemplateOrderBy
ConversationTemplateQuery
ConversationTemplateResult
ConversationTemplateSearchFilter
ConversationUpdatedEvent
ConversationsAddParticipantBody
ConversationsChangeParticipantVisibilityBody
ConversationsEndBody
ConversationsOffboardParticipantBody
ConversationsSetAssigneePersonBody
ConversationsSetContextPersonBody