Skip to main content
POST
Criar pessoa

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.1.

Corpo

application/json
full_name
string
obrigatório
Maximum string length: 70
Exemplo:

"Maria Silva"

emails
object[]
phones
object[]
company_id
string<uuid>
position
string
Maximum string length: 100
Exemplo:

"Head of Sales"

owner_email
string<email>

E-mail do membro do workspace a definir como responsável. A API resolve internamente para o ID do usuário. Deve ser membro deste workspace.

Exemplo:

"joao@empresa.com"

avatar_image
string

URL HTTPS pública da imagem ou Data URI base64 completo (ex: data:image/png;base64,...). Formatos aceitos: JPEG, PNG, WebP, GIF, BMP, TIFF.

Exemplo:

"data:image/png;base64,iVBORw0KGgo..."

tags
string[]

Nomes (keys) das tags a associar com a pessoa. Se a tag não existir, será criada automaticamente.

Required string length: 1 - 30
list_ids
string<uuid>[]

IDs de listas a associar com a pessoa.

custom_fields
object[]

Valores de campos adicionais a definir para a pessoa. Identificados por field_key. Se o campo não existir, é criado automaticamente com tipo text.

Resposta

Pessoa criada com sucesso.

data
object