SIsinch
Contact

Merge two Contacts

The remaining contact will contain all conversations that the removed contact did. If both contacts had conversations within the same App, messages from the removed contact will be merged into corresponding active conversations in the destination contact. Channel identities will be moved from the source contact to the destination contact only for channels that weren't present there before. Moved channel identities will be placed at the bottom of the channel priority list. Optional fields from the source contact will be copied only if corresponding fields in the destination contact are empty. The contact being removed cannot be referenced after this call.

post/v1/projects/{project_id}/contacts/{destination_id}:merge

Request

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

Request body

source_idstring required

Required. The ID of the contact that should be removed.

strategy'MERGE'

Response

A successful response.

channel_priorityConversationChannel[]

List of channels defining the channel priority.

display_namestring

The display name. A default 'Unknown' will be assigned if left empty.

emailstring

Email of the contact.

external_idstring

Contact identifier in an external system.

idstring

The ID of the contact.

language'AF' | 'SQ' | 'AR' | 'AZ' | 'BN' | 'BG' | 'CA' | 'ZH' | 'ZH_CN' | 'ZH_HK' | 'ZH_TW' | 'HR' | 'CS' | 'DA' | 'NL' | 'EN' | 'EN_GB' | 'EN_US' | 'ET' | 'FIL' | 'FI' | 'FR' | 'DE' | 'EL' | 'GU' | 'HA' | 'HE' | 'HI' | 'HU' | 'ID' | 'GA' | 'IT' | 'JA' | 'KN' | 'KK' | 'KO' | 'LO' | 'LV' | 'LT' | 'MK' | 'MS' | 'ML' | 'MR' | 'NB' | 'FA' | 'PL' | 'PT' | 'PT_BR' | 'PT_PT' | 'PA' | 'RO' | 'RU' | 'SR' | 'SK' | 'SL' | 'ES' | 'ES_AR' | 'ES_ES' | 'ES_MX' | 'SW' | 'SV' | 'TA' | 'TE' | 'TH' | 'TR' | 'UK' | 'UR' | 'UZ' | 'VI' | 'ZU'
metadatastring

Metadata associated with the contact. Up to 1024 characters long.

Example response

{
  "channel_identities": [
    {
      "channel": "WHATSAPP"
    }
  ],
  "channel_priority": [
    "WHATSAPP"
  ],
  "id": "{CONTACT_ID}"
}

Changes

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