Adicionar contato ao cliente | WBudget

Adiciona um contato ao cliente.

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

Retorna o cliente atualizado, incluindo a lista contacts. Consulte essa lista para obter o ID do contato criado. 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

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 contato.
`email`	string	Não	E-mail.
`phone`	string	Não	Telefone.
`national_id`	string	Não	Documento do contato.
`position`	string	Não	Cargo.
`address`	object	Não	Endereço do contato.
`main`	integer	Não	1 para contato principal; padrão 0.
`active`	integer	Não	1 para ativo; padrão 1.
`metadata`	object	Não	Campos personalizados do contato.

Exemplo de JSON enviado

{
  "name": "Ana Silva",
  "email": "[email protected]",
  "phone": "+5511999990000",
  "position": "Compras",
  "main": 1,
  "active": 1
}

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.
`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",
    "sponsor": "Ana Silva",
    "email": "[email protected]",
    "phone": "+5511999990000",
    "national_id": "11222333000181",
    "contacts": [
      {
        "id": 201,
        "name": "Ana Silva",
        "email": "[email protected]",
        "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.

Adiciona um contato ao cliente. **Autenticação:** Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário. Retorna o cliente atualizado, incluindo a lista contacts. Consulte essa lista para obter o ID do contato criado. 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 | 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 contato. | | `email` | string | Não | E-mail. | | `phone` | string | Não | Telefone. | | `national_id` | string | Não | Documento do contato. | | `position` | string | Não | Cargo. | | `address` | object | Não | Endereço do contato. | | `main` | integer | Não | 1 para contato principal; padrão 0. | | `active` | integer | Não | 1 para ativo; padrão 1. | | `metadata` | object | Não | Campos personalizados do contato. | ### Exemplo de JSON enviado ```json { "name": "Ana Silva", "email": "[email protected]", "phone": "+5511999990000", "position": "Compras", "main": 1, "active": 1 } ``` ### 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. | | `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", "sponsor": "Ana Silva", "email": "[email protected]", "phone": "+5511999990000", "national_id": "11222333000181", "contacts": [ { "id": 201, "name": "Ana Silva", "email": "[email protected]", "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.

Request

This endpoint expects an object.

namestringRequired

emailstringRequiredformat: "email"

phonestringRequired

positionstringRequired

mainintegerRequired

activeintegerRequired

Response

Created

dataobject