Contatos

Criar, buscar, editar e apagar contatos.

Contatos são as pessoas que falam com a sua organização. O telefone é único por organização (com ou sem o nono dígito): repetir dá 409 telefone_repetido.

Busque por busca (parte do nome ou do telefone, ou o e-mail exato), telefone ou email.
campos guarda campos personalizados (objeto livre, até 16 mil caracteres): convênio, plano, código no seu sistema...
No PATCH, mande só o que muda; null apaga o valor.
Apagar um contato apaga junto as conversas dele. Não tem volta.

Endpoints#

GETListar e buscar contatos/contatos
POSTCriar contato/contatos
GETVer um contato/contatos/{id}
PATCHAtualizar contato/contatos/{id}
DELApagar contato/contatos/{id}

Códigos de erro#

Além dos gerais (chave, limite, JSON), estes podem vir em erro.codigo nas rotas daqui. Todos estão em Erros.

Códigos de erro
codigo	O que significa
contato_inexistente	Contato não encontrado.
telefone_invalido	Telefone inválido. Mande com DDI e DDD.
telefone_repetido	Já existe um contato com esse telefone (com ou sem o 9).
cursor_invalido	Cursor inválido. Use o valor de "proximo" da página anterior.