Sign in
S2S Contacts

Create conversation

Open a conversation for a contact, authored as the contact. Pass workflowId to start a workflow, or agentId to engage an AI agent. The contact is created on the fly if it does not exist yet.

post/s2s/contacts/{userId}/conversations

Path parameters

userIdstring required

Request body

titlestring
messagestring required

The customer's first message.

{"stackTrail":"components:schemas:S2SCreateConversationBody:properties:attributes","oasType":"schema","type":"unknown","description":"Ticket attributes (data attributes); agent-only when the attribute's shared visibility is disabled."}
sourcestring

Free-form source tag, e.g. "abb-mobile".

tagsstring[]
workflowIdstring

Start this workflow immediately (wf_… or bare id). Mutually exclusive with agentId.

agentIdstring

Engage this AI agent directly. Mutually exclusive with workflowId.

Response

Created

idstring required
numbernumber double
titlestring
typestring
statusstring
closedboolean required
archivedboolean required
unreadboolean required
workflowActiveboolean required
workflowIdstring
attributesRecordStringUnknown

Construct a type with a set of properties K of type T

createdAtstring date-time
lastActivityAtstring date-time

Changes

Changed in 2 of the 22 revisions of this API.11