Atualizar cliente | WBudget

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

Campo	Tipo	Obrigatório	Descrição
`id`	integer	Sim	ID do cliente.

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`name`	string	Não	Nome do cliente.
`email`	string	Não	E-mail válido.
`phone`	string	Não	Telefone com código do país e DDD.
`national_id`	string	Não	Documento fiscal; mantenha como texto.
`sponsor`	string	Não	Nome do contato principal.
`address`	object	Não	Endereço do cliente.
`status`	string	Não	Situação do cadastro, conforme os valores usados na conta.
`metadata`	object	Não	Campos personalizados.
`main_contact`	object	Não	Dados 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": "[email protected]"
}

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:

Campo	Tipo	Descrição
`id`	integer	ID do cliente.
`name`	string	Nome.
`email`	string	E-mail.
`phone`	string	Telefone.
`national_id`	string	Documento.
`sponsor`	string	Contato principal.
`address`	object	Endereço.
`status`	string	Situação do cadastro.
`metadata`	object ou array	Valores personalizados, conforme configuração.
`contacts`	array<object>	Contatos do cliente.
`contacts[].id`	integer	ID para usar em contactId.
`contacts[].name`	string	Nome.
`contacts[].email`	string	E-mail.
`contacts[].phone`	string	Telefone.
`contacts[].position`	string	Cargo.
`contacts[].main`	integer	1 indica contato principal.
`contacts[].active`	integer	1 indica contato ativo.

{
  "data": {
    "id": 101,
    "name": "Empresa Exemplo Atualizada",
    "sponsor": "Ana Silva",
    "email": "[email protected]",
    "phone": "+5511999990000",
    "national_id": "11222333000181"
  }
}

Erros específicos

HTTP	Código	Situação
404	`CLIENT_NOT_FOUND`	Client not found.

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

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 | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `id` | integer | Sim | ID do cliente. | ### Corpo da requisição | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `name` | string | Não | Nome do cliente. | | `email` | string | Não | E-mail válido. | | `phone` | string | Não | Telefone com código do país e DDD. | | `national_id` | string | Não | Documento fiscal; mantenha como texto. | | `sponsor` | string | Não | Nome do contato principal. | | `address` | object | Não | Endereço do cliente. | | `status` | string | Não | Situação do cadastro, conforme os valores usados na conta. | | `metadata` | object | Não | Campos personalizados. | | `main_contact` | object | Não | Dados do contato principal: name, email, nid (documento) e phone. Esse objeto permite criar ou atualizar o contato principal. | ### Exemplo de JSON enviado ```json { "name": "Empresa Exemplo Atualizada", "email": "[email protected]" } ``` ### 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`: | Campo | Tipo | Descrição | |---|---|---| | `id` | integer | ID do cliente. | | `name` | string | Nome. | | `email` | string | E-mail. | | `phone` | string | Telefone. | | `national_id` | string | Documento. | | `sponsor` | string | Contato principal. | | `address` | object | Endereço. | | `status` | string | Situação do cadastro. | | `metadata` | object ou array | Valores personalizados, conforme configuração. | | `contacts` | array<object> | Contatos do cliente. | | `contacts[].id` | integer | ID para usar em contactId. | | `contacts[].name` | string | Nome. | | `contacts[].email` | string | E-mail. | | `contacts[].phone` | string | Telefone. | | `contacts[].position` | string | Cargo. | | `contacts[].main` | integer | 1 indica contato principal. | | `contacts[].active` | integer | 1 indica contato ativo. | ```json { "data": { "id": 101, "name": "Empresa Exemplo Atualizada", "sponsor": "Ana Silva", "email": "[email protected]", "phone": "+5511999990000", "national_id": "11222333000181" } } ``` ### Erros específicos | HTTP | Código | Situação | |---|---|---| | 404 | `CLIENT_NOT_FOUND` | Client 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.

namestringRequired

emailstringRequiredformat: "email"

Response

dataobject

Errors

404

Not Found Error