Referência da API

Contatos

Crie, liste, consulte e atualize contatos da sua conta.

Listar contatos

GET/api/v1/contacts

Requer o escopo crm:read. Aceita limit, offset e query (busca por nome).

bash

curl "https://app.pipecor.com/api/v1/contacts?query=maria&limit=25" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

Criar contato

POST/api/v1/contacts

Requer crm:write. Campos aceitos: name (obrigatório), email, phone, document, company_id, owner_id, external_id e custom_fields.

bash

curl -X POST https://app.pipecor.com/api/v1/contacts \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Maria Souza",
    "email": "maria@empresa.com",
    "phone": "+5562999999999",
    "document": "123.456.789-00",
    "external_id": "erp-4821"
  }'

Use external_id para amarrar o contato ao identificador dele no seu sistema — útil para evitar duplicidade nas próximas sincronizações.

Consultar um contato

GET/api/v1/contacts/{id}

Requer crm:read. Retorna 404 not_found se o contato não existir na sua conta.

Atualizar um contato

PATCH/api/v1/contacts/{id}

Requer crm:write. Envie apenas os campos que deseja alterar.

bash

curl -X PATCH https://app.pipecor.com/api/v1/contacts/CONTACT_ID \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{ "phone": "+5562988887777" }'