Pular para o conteúdo principal

Contatos do colaborador

As pessoas de contato ligadas ao cadastro do colaborador. A tela Colaboradores não tem aba de contatos; os campos de contato da pessoa ficam no formulário do colaborador.

Use o customer_vendor.uuid do colaborador (o uuid do cadastro da pessoa, não o do colaborador) nos caminhos abaixo.

Endpoints​

MétodoCaminhoDescrição
GET/administrative/employees/{customer_vendor_uuid}/contactsLista os contatos
POST/administrative/employees/{customer_vendor_uuid}/contactsCadastra um contato
GET/administrative/employees/{customer_vendor_uuid}/contacts/{id}Consulta um contato
PUT/administrative/employees/{customer_vendor_uuid}/contacts/{id}Altera um contato
DELETE/administrative/employees/{customer_vendor_uuid}/contacts/{id}Apaga um contato

O {id} é o id numérico do contato.

Endpoints de contatos​

GET /administrative/employees/{customer_vendor_uuid}/contacts​

Lista os contatos do cadastro.

Parâmetros de URL

ParâmetroDescrição
searchBusca pelo nome do contato
select_emailQuando informado, devolve só id, name e email
select_cellphoneQuando informado, devolve só id, name e cellphone
per_page e pagePaginação

Resposta: 200, lista de contatos com id, customer_vendor_id, name, email, phonenumber e cellphone.

POST /administrative/employees/{customer_vendor_uuid}/contacts​

Cadastra um contato.

Corpo

CampoObrigatórioTipoDescrição
nameSimTextoNome da pessoa de contato
emailNãoTextoE-mail do contato
cellphoneNãoTextoCelular do contato
phonenumberNãoTextoTelefone do contato

Resposta: 201, com o contato criado.

GET /administrative/employees/{customer_vendor_uuid}/contacts/{id} e DELETE /administrative/employees/{customer_vendor_uuid}/contacts/{id}​

Consultar e apagar um contato. A exclusão é lógica.

Resposta: 200.

PUT /administrative/employees/{customer_vendor_uuid}/contacts/{id}​

Altera um contato. Envie somente os campos que mudam, com os mesmos campos da criação.

Resposta: 200, com o contato alterado.