SIsinch
Conversation

Update a conversation

This operation updates a conversation which can, for instance, be used to update the metadata associated with a conversation.

patch/v1/projects/{project_id}/conversations/{conversation_id}

Request

  • Base URL
    https://us.conversation.api.sinch.com
  • URL
    https://us.conversation.api.sinch.com/v1/projects/{project_id}/conversations/{conversation_id}
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Query parameters

update_maskstring[]

The set of field mask paths.

metadata_update_strategy'REPLACE' | 'MERGE_PATCH'

Update strategy for the conversation_metadata field. Only supported in CONVERSATION processing mode.

Update strategy for the conversation_metadata field.

Request body

activeboolean

Flag for whether this conversation is active.

active_channel'SMS' | 'RCS' | 'WHATSAPP' | 'MMS' | 'KAKAOTALK' | 'KAKAOTALKCHAT' | 'VIBERBM' | 'LINE' | 'INSTAGRAM' | 'MESSENGER' | 'WECHAT' | 'TELEGRAM' | 'APPLEBC'

The identifier of the channel you want to include. Must be one of the enum values.

app_idstring

The ID of the participating app.

contact_idstring

The ID of the participating contact.

metadatastring

Arbitrary data set by the Conversation API clients. Up to 1024 characters long. NOTE: This field has been deprecated due to changes in the system architecture or functionality. It is no longer actively maintained and may be removed in future versions. Please avoid relying on this field in new code.

metadata_jsonobject

Arbitrary data set by the Conversation API clients and/or provided in the conversation_metadata field of a SendMessageRequest. A valid JSON object.

correlation_idstring

Arbitrary correlation ID related to the MT message set by the Conversation API user.

idstring

The ID of the conversation.

last_receivedstring date-time

The timestamp of the latest message in the conversation. The timestamp will be Thursday January 01, 1970 00:00:00 UTC if the conversation contains no messages.

Example request

{
  "active_channel": "WHATSAPP"
}

Response

A successful response.

activeboolean

Flag for whether this conversation is active.

active_channel'SMS' | 'RCS' | 'WHATSAPP' | 'MMS' | 'KAKAOTALK' | 'KAKAOTALKCHAT' | 'VIBERBM' | 'LINE' | 'INSTAGRAM' | 'MESSENGER' | 'WECHAT' | 'TELEGRAM' | 'APPLEBC'

The identifier of the channel you want to include. Must be one of the enum values.

app_idstring

The ID of the participating app.

contact_idstring

The ID of the participating contact.

metadatastring

Arbitrary data set by the Conversation API clients. Up to 1024 characters long. NOTE: This field has been deprecated due to changes in the system architecture or functionality. It is no longer actively maintained and may be removed in future versions. Please avoid relying on this field in new code.

metadata_jsonobject

Arbitrary data set by the Conversation API clients and/or provided in the conversation_metadata field of a SendMessageRequest. A valid JSON object.

correlation_idstring

Arbitrary correlation ID related to the MT message set by the Conversation API user.

idstring

The ID of the conversation.

last_receivedstring date-time

The timestamp of the latest message in the conversation. The timestamp will be Thursday January 01, 1970 00:00:00 UTC if the conversation contains no messages.

Example response

{
  "active_channel": "WHATSAPP"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.