Jump to Content

Guides API Reference Changelog

API Reference

Guides API Reference Changelog

Chats API

ChatsV

Live Chat API

ChatAttributes
ChatContext
- Get message contextget
- Get chat contextget
MessageKeywords
- Get keywords.get
Messages
RegisteredChats
- Get registered chat by IDget
- Creates a registered chatpost
Transcript
- Get a chat transcriptget
UserVerificationConfig
- Get user verification configget
- Create a user verification config.post

ChatBot Execution API

Execution
- Resume chatbot executionpost
JourneyInstances
- Creates journey instances.post
TextBotExecution
- Resume textbot executionpost

Custom Reports API

Queries
- Execute querypost

Asset Manager API

Assets
DataSets
Folders

SMS Chat API

SmsChats
- Gets all chats.get
SmsMessages
- Post SMS messagepost
TextBotExecutions
- Start text bot executionpost
- Get text bot by execution IDget

MedChat Utility API

RetentionJobs

MedChat Auth

CustomUserAttributes
- /v1/orgs/{orgId}/users/{userId}/customattributesget
- /v1/orgs/{orgId}/users/{userId}/customattributes/{attributeId}get

External Chats API V1

ExternalChatsFilesVersionless

Powered by

Gets a retention job.

get https://example.com/orgs/{orgId}/retentionJobs/{retentionJobId}

Language

Click Try It! to start a request and see the response here!