Gerenciamento dos contatos operacionais do cedente.
Adicionar Contato¶
| Método | URL |
|---|---|
https://BASE_URL/api/cedentes/{idEmpresa}/contatos |
Request Body
{
"nome": "Maria Financeiro",
"email": "maria@empresaexemplo.com.br",
"telefone": "47999887766"
}
Response Body
{
"idContato": 5,
"idEmpresa": 123,
"status": "Contato adicionado com sucesso."
}
Atualizar Contato¶
| Método | URL |
|---|---|
https://BASE_URL/api/cedentes/{idEmpresa}/contatos/{idContato} |
Request Body
{
"email": "maria.novo@empresaexemplo.com.br"
}
Response Body
{
"idContato": 5,
"status": "Contato atualizado com sucesso."
}
Remover Contato¶
| Método | URL |
|---|---|
https://BASE_URL/api/cedentes/{idEmpresa}/contatos/{idContato} |
Response Body
{
"status": "Contato removido com sucesso."
}
Modelo de Dados¶
Requisição — Contato¶
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
nome | Texto (200) | ✅ | Nome do contato |
email | Texto (200) | Opcional¹ | E-mail do contato |
telefone | Texto (30) | Opcional¹ | Telefone do contato |
Nota
¹ Pelo menos um dos campos email ou telefone deve ser informado.
Retorno¶
| Campo | Tipo | Descrição |
|---|---|---|
idContato | Número | ID do contato |
idEmpresa | Número | ID da empresa cedente |
status | Texto | Mensagem de status da operação |