Contatos da empresa

Contatos são as pessoas de contato de uma empresa. Correspondem à lista Contatos da aba Cadastros, na tela Empresas. Os contatos aparecem como destinatários nas telas de envio de certificados.

Endpoints

Método	Caminho	Descrição
GET	/administrative/business/{customer_vendor_uuid}/contacts	Lista os contatos da empresa
POST	/administrative/business/{customer_vendor_uuid}/contacts	Cadastra um contato
GET	/administrative/business/{customer_vendor_uuid}/contacts/{id}	Consulta um contato
PUT	/administrative/business/{customer_vendor_uuid}/contacts/{id}	Altera um contato
DELETE	/administrative/business/{customer_vendor_uuid}/contacts/{id}	Apaga um contato

O {customer_vendor_uuid} é o uuid da empresa, retornado pela consulta de empresas. O {id} é o id numérico do contato.

Os mesmos endpoints existem com o caminho customers, com o mesmo comportamento:

Método	Caminho equivalente
GET	/administrative/customers/{customer_vendor_uuid}/contacts
POST	/administrative/customers/{customer_vendor_uuid}/contacts
GET	/administrative/customers/{customer_vendor_uuid}/contacts/{id}
PUT	/administrative/customers/{customer_vendor_uuid}/contacts/{id}
DELETE	/administrative/customers/{customer_vendor_uuid}/contacts/{id}

Endpoints de contatos

GET /administrative/business/{customer_vendor_uuid}/contacts

Lista os contatos da empresa.

Parâmetros de URL

Parâmetro	Descrição
search	Busca pelo nome do contato
select_email	Quando informado, devolve só id, name e email (para listas de seleção)
select_cellphone	Quando informado, devolve só id, name e cellphone (para listas de seleção)
per_page e page	Paginação

Resposta: 200, lista de contatos com id, customer_vendor_id, name, email, phonenumber e cellphone, além dos nomes de quem criou e alterou.

POST /administrative/business/{customer_vendor_uuid}/contacts

Cadastra um contato na empresa.

Corpo

Campo	Obrigatório	Tipo	Descrição
name	Sim	Texto	Nome da pessoa de contato
email	Não	Texto	E-mail do contato
cellphone	Não	Texto	Celular do contato
phonenumber	Não	Texto	Telefone do contato

Resposta: 201, com o contato criado.

GET /administrative/business/{customer_vendor_uuid}/contacts/{id} e DELETE /administrative/business/{customer_vendor_uuid}/contacts/{id}

Consultar e apagar um contato. A exclusão é lógica e não verifica se o contato está em uso.

Resposta: 200.

PUT /administrative/business/{customer_vendor_uuid}/contacts/{id}

Altera um contato. Envie somente os campos que mudam. Os campos são os mesmos da criação, e nenhum é obrigatório nesta chamada.

Resposta: 200, com o contato alterado.