Skip to main content
POST
Conferir identificadores de contato

Autorizações

Authorization
string
header
obrigatório

Token JWT de autenticação

Cabeçalhos

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Corpo

application/json
email
string

E-mail a conferir. Só conta como identificador se tiver "@".

linkedin_identifier
string

URL do perfil do LinkedIn ou só o nome do perfil.

phone_number
string

Telefone (DDD + número, sem o DDI). Telefone que não forma número válido é ignorado na conferência.

country_code
string

DDI do telefone. Exemplo: 55.

exclude_contact_id
string

Contato a ignorar na conferência. A edição manda o próprio contato: valor igual ao dele não é conflito.

Pattern: ^[0-9a-fA-F]{24}$

Resposta

200 - application/json

Resultado da conferência

status
enum<string>
obrigatório

new: nenhum contato tem os identificadores. existing: o POST reaproveitaria contact. conflict: identificadores diferentes apontam para contatos diferentes.

Opções disponíveis:
new,
existing,
conflict
matched_by
enum<string> | null
obrigatório

Identificador que casou

Opções disponíveis:
email,
linkedin,
phone
matches_count
number
obrigatório

Quantos contatos da empresa casaram pela chave matched_by.

contact
object | null
obrigatório

Contato que seria reaproveitado. null em new e conflict.

conflicts
object[]
obrigatório

Em conflict, o contato de cada identificador. Vazio nos outros casos.