S2S Contacts

Create conversation

Changed on

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

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/s2s/contacts/{userId}/conversations
  • Auth
    HTTP bearer

Path parameters

userIdstring required

Request body

titlestring
messagestring required

The customer's first message.

attributesunknown
sourcestring

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

typestring

Ticket type, e.g. "BUG". One of the project's ticket types; defaults to "INQUIRY". FEATURE_REQUEST and CRASH are not allowed.

tagsstring[]
workflowIdstring

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

agentIdstring

Engage this AI agent directly. Mutually exclusive with workflowId.

Example request

{
  "type": "BUG"
}

Response

Created

idstring required
numbernumber double
titlestring
typestring
statusstring
closedboolean required
archivedboolean required
unreadboolean required
ratingnumber double

CSAT rating 0-10 given by the contact (rateconversation step or POST …/rating).

workflowActiveboolean required
workflowIdstring
attributesRecordStringUnknown

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

createdAtstring date-time
lastActivityAtstring date-time

Changes