Messaging

Retrieve a chat

Changed on

Retrieve the details of a chat.

get/api/v1/chats/{chat_id}

Request

Path parameters

chat_idstring required

The Unipile or provider ID of the chat.

Query parameters

account_idstring

Mandatory if the chat ID is a provider ID.

Response

OK. Request succeeded.

idstring required

A unique identifier.

account_idstring required

A unique identifier.

provider_idstring required
attendee_provider_idstring
unread_countnumber required
subjectstring
organization_idstring

Linkedin specific ID for organization mailboxes.

mailbox_idstring

Linkedin specific ID for organization mailboxes.

object'Chat' required

Changes

    • warning

      added the new errors/password_reset_required enum value to the response property for the response status

    • info

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

    • info

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

    • info

      added subschema #15 to the // response property anyOf list for the response status

    • info

      added subschema #7 subschema #8 subschema #9 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #7 subschema #8 subschema #9 subschema #10 to the //// response property anyOf list for the response status