SUsuperchat
Conversation Exports

Create a conversation export

Changed on

Creates a conversation export job

post/conversations/{conversationId}/export

Request

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

Path parameters

conversationIdstring required

Public ID of the conversation.

Request body

startstring date-time nullable required

The start time of the export range

endstring date-time nullable required

The end time of the export range

Example request

{
  "start": "2022-03-10T16:15:50Z",
  "end": "2022-03-10T16:15:50Z"
}

Response

OK

idstring required

The ID of the conversation export

startstring date-time required
endstring date-time required
status'pending' | 'done' | 'failed' required

Example response

{
  "start": "2022-03-10T16:15:50Z",
  "end": "2022-03-10T16:15:50Z",
  "link": {
    "valid_until": "2022-03-10T16:15:50Z"
  }
}

Changes

  • 31e7bd6f37e9Revision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • 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