v1

latestOpenAPI 3.1.02026-07-2458221215.8 KB
Conversations

Update a conversation

Updates data of a conversation

patch/conversations/{id}

Path parameters

idstring required

Public ID of the conversation.

Request body

status'open' | 'done' | 'spam' | 'archived' | 'snoozed' nullable

The new status of the conversation

inbox_idstring nullable

The ID of the inbox to assign to the conversation

snoozed_untilstring date-time nullable

The time until which the conversation should be snoozed

Example request

{
  "snoozed_until": "2022-03-10T16:15:50Z"
}

Response

OK

idstring

The ID of the conversation

status'open' | 'done' | 'spam' | 'archived' | 'snoozed'
snoozed_untilstring date-time nullable

The time until which the conversation is snoozed

urlstring

The URL of the conversation resource

Example response

{
  "snoozed_until": "2022-03-10T16:15:50Z",
  "time_window": {
    "open_until": "2022-03-10T16:15:50Z"
  }
}