Pular para o conteúdo

GET /v1/contacts/{id}/merge-preview

GET
/v1/contacts/{id}/merge-preview
curl --request GET \
--url 'https://seu-endereco-da-api/v1/contacts/example/merge-preview?mergedContactId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Unir contatos duplicados (contacts:merge) e Ver o telefone inteiro do contato (contacts:read_phone).

id
required
string
mergedContactId
required
string format: uuid

Contact that will be absorbed

Media typeapplication/json
object
survivingContact
required
object
id
required
string
aiFilledFields

Present on the detail: the fields the AI filled, each with what it did and whether it can be undone.

Array<object>
object
fieldsUpdatedAt

Present on the detail: field key to the ISO instant it last changed, read from the value history; a field the caller cannot see is left out.

object
canEdit
required

The caller may edit this contact: one of their conversations or deals, a contact they created with no conversation, or contacts:update_all

boolean
name
required
string
phoneNumber
required
string
email
required

Masked to the domain for readers without contacts:read_phone

string
nullable
provider
required
string
attributes
required
object
key
additional properties
any
hiddenAttributes
required

Keys of protected fields the contact has filled in; the value only comes from the reveal route

Array<string>
optedOut
required

True when the contact must not receive campaigns, sequences or automations

boolean
optedOutAt
required
string format: date-time
nullable
anonymizedAt
required

Quando os dados pessoais deste contato foram apagados a pedido; o historico segue existindo

string format: date-time
nullable
blocked
required

Set while the contact is blocked; inbound is stored silently and nothing is sent

object
at
required
string format: date-time
reason
required
string
Allowed values: spam engano sem_interesse duplicado outro
by
required
object
id
required
string
name
required
string
nullable
origin
required
object
id
required
string
name
required
string
color
required
string
nullable
defaultDepartment
required
object
id
required
string
name
required
string
defaultDepartmentHidden
required

True when the contact has a default department the reader may not see; defaultDepartment is then null, and the screen must not offer to replace it as if it were empty

boolean
company
required
object
id
required
string
name
required
string
jobTitle
required

Cargo da pessoa na empresa

string
nullable
tags
required
Array<object>
object
id
required
string
name
required
string
color
required
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
profilePicUrl
required

Presigned url for the contact’s whatsapp profile photo

string
nullable
mergedIntoContactId
required

Id of the contact this one was merged into

string
nullable
mergedContact
required
object
id
required
string
aiFilledFields

Present on the detail: the fields the AI filled, each with what it did and whether it can be undone.

Array<object>
object
fieldsUpdatedAt

Present on the detail: field key to the ISO instant it last changed, read from the value history; a field the caller cannot see is left out.

object
canEdit
required

The caller may edit this contact: one of their conversations or deals, a contact they created with no conversation, or contacts:update_all

boolean
name
required
string
phoneNumber
required
string
email
required

Masked to the domain for readers without contacts:read_phone

string
nullable
provider
required
string
attributes
required
object
key
additional properties
any
hiddenAttributes
required

Keys of protected fields the contact has filled in; the value only comes from the reveal route

Array<string>
optedOut
required

True when the contact must not receive campaigns, sequences or automations

boolean
optedOutAt
required
string format: date-time
nullable
anonymizedAt
required

Quando os dados pessoais deste contato foram apagados a pedido; o historico segue existindo

string format: date-time
nullable
blocked
required

Set while the contact is blocked; inbound is stored silently and nothing is sent

object
at
required
string format: date-time
reason
required
string
Allowed values: spam engano sem_interesse duplicado outro
by
required
object
id
required
string
name
required
string
nullable
origin
required
object
id
required
string
name
required
string
color
required
string
nullable
defaultDepartment
required
object
id
required
string
name
required
string
defaultDepartmentHidden
required

True when the contact has a default department the reader may not see; defaultDepartment is then null, and the screen must not offer to replace it as if it were empty

boolean
company
required
object
id
required
string
name
required
string
jobTitle
required

Cargo da pessoa na empresa

string
nullable
tags
required
Array<object>
object
id
required
string
name
required
string
color
required
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
profilePicUrl
required

Presigned url for the contact’s whatsapp profile photo

string
nullable
mergedIntoContactId
required

Id of the contact this one was merged into

string
nullable
resultingContact
required
object
name
required
string
phoneNumber
required
string
nullable
email
required
string
nullable
attributes
required
object
key
additional properties
any
hiddenAttributes
required

Keys of protected fields the contact has filled in; the value only comes from the reveal route

Array<string>
origin
required
object
id
required
string
name
required
string
color
required
string
nullable
defaultDepartment
required
object
id
required
string
name
required
string
profilePicUrl
required
string
nullable
optedOut
required
boolean
blocked
required

True when either contact is blocked; the block survives the merge

boolean
companyId
required
string
nullable
jobTitle
required
string
nullable
tags
required
Array<object>
object
id
required
string
name
required
string
color
required
string
nullable
fieldConflicts
required

Campos preenchidos nos dois contatos com valores diferentes: o do sobrevivente vence, a não ser que a fusão leve a chave em keepMergedFields

Array<object>
object
key
required

Chave do campo disputado

string
label
required

Rótulo do campo, como a conta o nomeou

string
survivingValue
required

Valor do contato que sobrevive, que fica a não ser que a chave vá em keepMergedFields; null quando o campo é protegido

object
mergedValue
required

Valor do contato absorvido, que fica quando a chave vai em keepMergedFields; null quando o campo é protegido

object
sensitive
required

True quando o campo é protegido, e por isso nenhum dos dois valores é enviado

boolean
survivingChangedAt
required

Última gravação do valor no sobrevivente, ou a criação do contato quando não há histórico

string format: date-time
mergedChangedAt
required

Última gravação do valor no absorvido, ou a criação do contato quando não há histórico

string format: date-time
mostRecent
required

Lado com o valor gravado por último; empate fica com o sobrevivente

string
Allowed values: surviving merged
moving
required
Array<object>
object
resource
required

What kind of record moves, e.g. deals, tasks, tags

string
count
required
number
conversations
required
number
messages
required
number
unifiedConversations
required

Conversations of the absorbed contact that share a channel and get folded into the survivor’s

number

Example

{
"survivingContact": {
"blocked": {
"reason": "spam"
}
},
"mergedContact": {
"blocked": {
"reason": "spam"
}
},
"fieldConflicts": [
{
"mostRecent": "surviving"
}
]
}