Skip to navigation

Criar cliente

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

CampoTipoObrigatórioDescrição
namestringSimNome 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.

Exemplo de JSON enviado

{
"name": "Empresa Exemplo",
"email": "contato@example.com",
"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:

CampoTipoDescrição
idintegerID do cliente criado.
namestringNome do cliente.
{
"data": {
"id": 101,
"name": "Empresa Exemplo"
}
}

Erros específicos

HTTPCódigoSituação
422VALIDATION_FAILEDThe 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.
emailstringOptional
namestringOptional
national_idstringOptional
phonestringOptional
sponsorstringOptional

Response

201 — Sucesso — exemplo ilustrativo

dataobjectOptional

Errors

422
Unprocessable Entity Error