S2S Conversations

Close conversation

Close the conversation for the contact. Further contact messages are rejected with conversation_closed until it is reopened.

POST

https://api.gleap.io/v3/s2s/conversations/{conversationId}/close

Authorizations

Authorizationstring · headerrequired

Bearer authentication header of the form Bearer <token>.

Path parameters

conversationIdstringrequired

Response

application/json

idstringrequired

numbernumber<double>

titlestring

typestring

statusstring

closedbooleanrequired

Show 11 more attributes

archivedbooleanrequired

unreadbooleanrequired

ratingnumber<double>

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

workflowActivebooleanrequired

workflowIdstring

assigneeobject | null

Show child attributes

typeenum<string>required

Allowed values: contactagentbotsystem

idstring

namestring

avatarstring

attributesobject

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

contactobject

Show child attributes

userIdstring

latestMessageobject

Show child attributes

idstringrequired

conversationIdstringrequired

textstring

authorobjectrequired

Show child attributes

typeenum<string>required

Allowed values: contactagentbotsystem

idstring

namestring

avatarstring

attachmentsobject[]required

Show child attributes

urlstringrequired

namestring

contentTypestring

replyToMessageIdstring

Show 3 more attributes

ratingstring

unreadbooleanrequired

createdAtstring<date-time>required

createdAtstring<date-time>

lastActivityAtstring<date-time>

Updated November 1, 2026

curl --request POST \
  --url 'https://api.gleap.io/v3/s2s/conversations/{conversationId}/close' \
  --header 'Authorization: Bearer <token>'

{
  "id": "string",
  "number": 0,
  "title": "string",
  "type": "string",
  "status": "string",
  "closed": true,
  "archived": true,
  "unread": true,
  "rating": 0,
  "workflowActive": true,
  "workflowId": "string",
  "assignee": {
    "type": "contact",
    "id": "string",
    "name": "string",
    "avatar": "string"
  },
  "attributes": {},
  "contact": {
    "userId": "string"
  },
  "latestMessage": {
    "id": "string",
    "conversationId": "string",
    "text": "string",
    "author": {
      "type": "contact",
      "id": "string",
      "name": "string",
      "avatar": "string"
    },
    "attachments": [
      {
        "url": "string",
        "name": "string",
        "contentType": "string"
      }
    ],
    "replyToMessageId": "string",
    "rating": "string",
    "unread": true,
    "createdAt": "2026-01-01T12:00:00Z"
  },
  "createdAt": "2026-01-01T12:00:00Z",
  "lastActivityAt": "2026-01-01T12:00:00Z"
}

Response

application/json

idstringrequired

numbernumber<double>

titlestring

typestring

statusstring

closedbooleanrequired

Show 11 more attributes

archivedbooleanrequired

unreadbooleanrequired

ratingnumber<double>

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

workflowActivebooleanrequired

workflowIdstring

assigneeobject | null

Show child attributes

typeenum<string>required

Allowed values: contactagentbotsystem

idstring

namestring

avatarstring

attributesobject

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

contactobject

Show child attributes

userIdstring

latestMessageobject

Show child attributes

idstringrequired

conversationIdstringrequired

textstring

authorobjectrequired

Show child attributes

typeenum<string>required

Allowed values: contactagentbotsystem

idstring

namestring

avatarstring

attachmentsobject[]required

Show child attributes

urlstringrequired

namestring

contentTypestring

replyToMessageIdstring

Show 3 more attributes

ratingstring

unreadbooleanrequired

createdAtstring<date-time>required

createdAtstring<date-time>

lastActivityAtstring<date-time>

{ "id": "string", "number": 0, "title": "string", "type": "string", "status": "string", "closed": true, "archived": true, "unread": true, "rating": 0, "workflowActive": true, "workflowId": "string", "assignee": { "type": "contact", "id": "string", "name": "string", "avatar": "string" }, "attributes": {}, "contact": { "userId": "string" }, "latestMessage": { "id": "string", "conversationId": "string", "text": "string", "author": { "type": "contact", "id": "string", "name": "string", "avatar": "string" }, "attachments": [ { "url": "string", "name": "string", "contentType": "string" } ], "replyToMessageId": "string", "rating": "string", "unread": true, "createdAt": "2026-01-01T12:00:00Z" }, "createdAt": "2026-01-01T12:00:00Z", "lastActivityAt": "2026-01-01T12:00:00Z" }