Criar um cliente

Atualizado em 17 de outubro de 2026

Considerações

Exige o escopo clients:write e a permissão de criar em Clientes.
Obrigatórios: type (pf ou pj), name e email (único na base).
Para pessoa jurídica, contributor_type é obrigatório.
cpf/cnpj podem vir com ou sem máscara; são guardados só com dígitos.
Com phone (e phone_ddd, que assume 55 quando ausente), o contato de WhatsApp é criado junto.

Referência

Como fazer

Envie um POST para /clients com os dados do cliente:

cURL

curl -X POST "$MICORE_BASE_URL/clients" \
  -H "Authorization: Bearer $MICORE_TOKEN" \
  -H "Accept: application/json" \
  -H "Idempotency-Key: request-2026-0001" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "pf",
    "name": "Maria Oliveira",
    "email": "maria@exemplo.com",
    "cpf": "123.456.789-09",
    "phone_ddd": "55",
    "phone": "41999998888"
}'

Resposta

Em caso de sucesso, a API responde 201 com o cliente criado:

Resposta · 201

{
  "data": {
    "id": 42,
    "kind": "client",
    "type": "pf",
    "name": "Maria Oliveira",
    "document": { "type": "cpf", "value": "12345678909" },
    "email": "maria@exemplo.com",
    "status": true,
    "group_id": 1,
    "created_at": "2026-10-17T09:00:00-03:00",
    "updated_at": "2026-10-17T09:00:00-03:00"
  }
}

Precisa de ajuda?Use o request ID e abra um chamado no miCore se encontrar uma divergência.