Skip to navigation

Atualizar contato do cliente

Atualiza um contato do cliente.

Autenticação: Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário.

Envie os dados completos que deseja manter. Campos omitidos podem ser substituídos por valores vazios ou padrão. Retorna o cliente atualizado. main=1 define este contato como principal. main=0 remove a indicação de contato principal do cliente. Os valores de main e active são numéricos (0 ou 1).

Parâmetros de caminho

CampoTipoObrigatórioDescrição
idintegerSimID do cliente.
contactIdintegerSimID do contato.

Corpo da requisição

CampoTipoObrigatórioDescrição
namestringNãoNome do contato.
emailstringNãoE-mail.
phonestringNãoTelefone.
national_idstringNãoDocumento do contato.
positionstringNãoCargo.
addressobjectNãoEndereço do contato.
mainintegerNão1 para contato principal; padrão 0.
activeintegerNão1 para ativo; padrão 1.
metadataobjectNãoCampos personalizados do contato.

Exemplo de JSON enviado

{
"name": "Ana Silva",
"email": "ana@example.com",
"phone": "+5511999990000",
"position": "Compras",
"main": 1,
"active": 1
}

Resposta

HTTP 200. Os exemplos usam dados fictícios e mostram os campos principais; outros campos podem acompanhar a resposta. Campos sem valor podem ser nulos.

Campos principais de data:

CampoTipoDescrição
idintegerID do cliente.
namestringNome.
emailstringE-mail.
phonestringTelefone.
national_idstringDocumento.
sponsorstringContato principal.
addressobjectEndereço.
statusstringSituação do cadastro.
metadataobject ou arrayValores personalizados, conforme configuração.
contactsarray<object>Contatos do cliente.
contacts[].idintegerID para usar em contactId.
contacts[].namestringNome.
contacts[].emailstringE-mail.
contacts[].phonestringTelefone.
contacts[].positionstringCargo.
contacts[].maininteger1 indica contato principal.
contacts[].activeinteger1 indica contato ativo.
{
"data": {
"id": 101,
"name": "Empresa Exemplo",
"sponsor": "Ana Silva",
"email": "contato@example.com",
"phone": "+5511999990000",
"national_id": "11222333000181",
"contacts": [
{
"id": 201,
"name": "Ana Silva",
"email": "ana@example.com",
"phone": "+5511999990000",
"position": "Compras",
"main": 1,
"active": 1
}
]
}
}

Consulte a introdução da collection para o formato de erros e a configuração das variáveis.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
ID do cliente.
contactIdstringRequired
ID do contato.

Request

This endpoint expects an object.
activedoubleOptional
emailstringOptional
maindoubleOptional
namestringOptional
phonestringOptional
positionstringOptional

Response

200 — Sucesso — exemplo ilustrativo

dataobjectOptional