DataBolsa docs
Referência da APIExtensõesAdvisorClientes

Cadastrar cliente

Cadastra um cliente do escritório (pessoa ou entidade) com contato, documento, família, situação inicial e assessor responsável. Escrita: entra na trilha de auditoria e exige licença vigente.

POST
/v1/advisor/orgs/{org}/clients

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

orgstring

Id ou slug da organização (de advisorGetMe).

Request Body

namestring

Nome do cliente (mín. 2 caracteres).

Length2 <= length
kind?string

person = pessoa física (default); entity = pessoa jurídica.

Value in"person" | "entity"
email?string | null

E-mail de contato.

Formatemail
phone?string | null

Telefone de contato.

document_id?string | null

CPF ou CNPJ, só dígitos.

family_id?string | null

Família a que pertence (de advisorListFamilies).

status?string

Situação inicial: prospect ou active (default active).

Value in"prospect" | "active"
owner_member_id?string | null

Assento do assessor responsável (de advisorListMembers).

Response Body

curl -X POST "https://api.databolsa.com/v1/advisor/orgs/string/clients" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "id": "string",
  "kind": "person",
  "name": "string",
  "email": "string",
  "phone": "string",
  "document_id": "string",
  "family_id": "string",
  "status": "prospect",
  "created_at": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string"
}

Atualizar nome/configurações da organização

Inclui `settings.client_visibility`: `all` (todos veem todos os clientes) ou `assigned` (assessor/viewer só veem clientes atribuídos); e `settings.seat_assignment`: `automatic` (todo membro da organização ganha assento na primeira visita) ou `manual` (só dono/administrador da organização entram sozinhos; os demais precisam de assento criado em `POST /orgs/{org}/members`).

Criar família (agrupamento de clientes)

Cria uma família (agrupamento de clientes) com nome e observação opcional.