Home//
- CreateConversationRequest
GetUserRequest
UpdateUserRequest
CreateUserRequest
GetConversationRequest
UpdateConversationRequest
GetMessagesRequest
CreateMessageRequest
WebhookConversationEventRequest
EndUserResponse
AgentsResponse
ConversationResponse
CreateConversationResponse
MessagesResponse
MessageResponse
EndUser
Agent
Conversation
Message
Attachment
ProblemDetails
CustomAttributes
ConversationAttributes
ConversationStatus
MessageType
MessageVisibility
HtmlMessageBody
UserBasic
MessageInput
MessageAuthor
CreateConversationRequest
userobject(UserBasic)
Basic user information for requests
attributesobject(ConversationAttributes)
Attributes associated with the conversation
Example:
{ "issue_type": "Billing", "priority": "High" }
initial_messageobject(MessageInput)
Message input fields for creation. Either body or attachments (or both) must be provided. A message cannot be empty - it must contain either text content or at least one attachment.
{ "title": "Question about pricing", "user": { "id": "user_123456", "name": "Jane Doe", "email": "jane.doe@example.com", "photo_url": "https://example.com/avatars/jane.jpg", "user_type": "end_user", "attributes": { … } }, "object_id": "123456", "attributes": { "issue_type": "Billing", "priority": "High" }, "initial_message": { "message_type": "comment", "body": "string", "author": { … }, "visibility": "public", "object_id": "123456", "attachments": [ … ] } }