Conversations

Update a conversation

Changed on

Updates data of a conversation

patch/conversations/{id}

Request

  • Base URL
    https://api.superchat.com/v1.0
  • URL
    https://api.superchat.com/v1.0/conversations/{id}
  • Auth
    API key in header X-API-KEY

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 required

The ID of the conversation

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

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"
  }
}

Changes

    • warning

      added the new call enum value to the ///// response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property ///// became required for the status

    • info

      the response property ///// became required for the status

    • info

      added the required property // to the response with the status