Skip to navigation

Atualizar cliente

Atualiza os dados de um cliente.

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

Campos omitidos, nulos ou vazios preservam os valores atuais. Retorna o cadastro atualizado.

Parâmetros de caminho

CampoTipoObrigatórioDescrição
idintegerSimID do cliente.

Corpo da requisição

CampoTipoObrigatórioDescrição
namestringNãoNome do cliente.
emailstringNãoE-mail válido.
phonestringNãoTelefone com código do país e DDD.
national_idstringNãoDocumento fiscal; mantenha como texto.
sponsorstringNãoNome do contato principal.
addressobjectNãoEndereço do cliente.
statusstringNãoSituação do cadastro, conforme os valores usados na conta.
metadataobjectNãoCampos personalizados.
main_contactobjectNãoDados do contato principal: name, email, nid (documento) e phone. Esse objeto permite criar ou atualizar o contato principal.

Exemplo de JSON enviado

{
"name": "Empresa Exemplo Atualizada",
"email": "compras@example.com"
}

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 Atualizada",
"sponsor": "Ana Silva",
"email": "compras@example.com",
"phone": "+5511999990000",
"national_id": "11222333000181"
}
}

Erros específicos

HTTPCódigoSituação
404CLIENT_NOT_FOUNDClient not found.

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.

Request

This endpoint expects an object.
emailstringOptional
namestringOptional

Response

200 — Sucesso — exemplo ilustrativo

dataobjectOptional

Errors

404
Not Found Error