ZaplinDocs
GuiasReferência da APIMCPChangelogAbrir o app

Criar contato

POST
/v1/contacts

Cria um contato pelo telefone (E.164, ex.: +5511999990000).

Escopo: contacts:write

Autorização

bearer contacts:write
headerAutorizaçãoBearer <token>

A chave de API de uma conta de serviço (sk_live_…, 600 requisições por minuto cada) ou um access token OAuth para o recurso /api/v1 (600 requisições por minuto por conexão).

Escopo: contacts:write

Cabeçalhos

Idempotency-Key?string

Até 200 letras, dígitos, - ou _. A primeira resposta a uma chave é repetida por 24 horas.

Tamanholength <= 200

Corpo da requisição

application/json
  1. body
name*string
Tamanho1 <= length <= 200
phone*string
Tamanholength <= 40
email?string
Padrão^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatoemail
Tamanholength <= 200

Corpo da resposta

Feito.

application/json
  1. response
id*string
name*string
phone*string|null
email*string|null
opted_out*boolean
created_at*string
Formatodate-time
tags*array<string>
fields*
Exemplo de requisição
curl -X POST 'https://app.zaplin.com.br/api/v1/contacts' \  -H 'Authorization: Bearer sk_live_...' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "phone": "string"}'
Exemplo de resposta
{  "id": "string",  "name": "string",  "phone": "string",  "email": "string",  "opted_out": false,  "created_at": "2026-10-17T12:00:00.000Z",  "tags": [    "string"  ],  "fields": {}}