Criar cliente | WBudget | Documentation

Cria um cliente.

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

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`name`	string	Sim	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.

Exemplo de JSON enviado

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

Resposta

HTTP 201. 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 criado.
`name`	string	Nome do cliente.

{
  "data": {
    "id": 101,
    "name": "Empresa Exemplo"
  }
}

Erros específicos

HTTP	Código	Situação
422	`VALIDATION_FAILED`	The name field is required.

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

Cria um cliente. **Autenticação:** Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário. ### Corpo da requisição | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `name` | string | Sim | 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. | ### Exemplo de JSON enviado ```json { "name": "Empresa Exemplo", "email": "[email protected]", "phone": "+5511999990000", "national_id": "11222333000181", "sponsor": "Ana Silva" } ``` ### Resposta HTTP **201**. 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 criado. | | `name` | string | Nome do cliente. | ```json { "data": { "id": 101, "name": "Empresa Exemplo" } } ``` ### Erros específicos | HTTP | Código | Situação | |---|---|---| | 422 | `VALIDATION_FAILED` | The name field is required. | 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.

Request

This endpoint expects an object.

namestringRequired

emailstringRequiredformat: "email"

phonestringRequired

national_idstringRequired

Response

Created

dataobject

Errors

422

Unprocessable Entity Error