Pular para o conteúdo principal

ReferênciaContacts

Contacts

Criar, buscar, upsert por email/telefone.

POST/api/v1/contacts

Crie com pelo menos display_name. Email é recomendado. Telefone com menos de 7 ou mais de 15 dígitos é 400. PATCH não muda email nem phone.

HTTPPathScope
GET/api/v1/contactsrest.crm.contacts.read
POST/api/v1/contactsrest.crm.contacts.write
POST/api/v1/contacts/upsertrest.crm.contacts.write
GET/api/v1/contacts/{id}rest.crm.contacts.read
PATCH/api/v1/contacts/{id}rest.crm.contacts.write

Query

ParâmetroTipoNotas
emailstringLookup do email primário. Miss é data: [], não 404.
phonestringLookup do telefone primário. Miss é data: [].
qstringBusca nome, email, phone e empresa.
limit / cursornumber / stringPágina de cursor. limit 1–100, default 20.

Campos

CampoTipoCreatePATCHNotas
idUUID—nãoImutável.
display_namestring | nullsimsimObrigatório no create. Parte em first + last.
emailstring | nullsimnãoEmail primário. Só no create.
phonestring | nullsimnão7–15 dígitos. Day 1 grava como BR +55.
company_idUUID | nullsimsimEmpresa desta org, ou null.
owner_idUUID | nullsimsimMesmo id de GET /members.
tag_idsUUID[]simsimReplace total. [] limpa.
created_at / updated_atdatetime—nãoISO-8601 UTC.

Upsert casa email, depois phone. created: true e 201 na inserção; created: false e 200 no update. Email/phone não mudam no update. Não precisa de Idempotency-Key para não duplicar — o upsert é o contrato de identidade.