Criar nova pessoa
POST
https://api.cubosuite.com.br/peoples
Descrição
Campos
| Campo | Tipo | Descrição |
|---|---|---|
| name | string | Nome da pessoa. Campo obrigatório. |
| phone | string (opcional) | Telefone da pessoa. Será normalizado (removidos caracteres não numéricos). |
| organizationId | number (opcional) | ID da organização à qual a pessoa pode estar vinculada. Deve existir na empresa do usuário. |
| customfields | array de objetos | Lista opcional de campos personalizados para a pessoa. Cada objeto deve conter: |
| customfieldId | - Id do Campo Personalizado (number): ID válido de customfield para o contexto 'people' na empresa. | |
| value | - value : Valor do campo personalizado. |
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.cubosuite.com.br/peoples' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "João Silva",
"phone": "(11) 91234-5678",
"organizationId": 864
}'Response Response Example
{
"name": "João Silva",
"phone": "(11) 91234-5678",
"companyId": 1,
"userId": 52312,
"status": "active",
"normalizedPhone": "11912345678",
"createdAt": "2025-06-23T11:18:26.515-03:00",
"updatedAt": "2025-06-23T11:18:26.515-03:00",
"id": 1313274317,
"annotations": [],
"customfields": []
}Requisição
Parâmetros Header
Content-Type
string
opcional
Exemplo:
application/json
Parâmetros Bodyapplication/json
Respostas
Modificado em 2025-06-23 14:24:53