Criar nova anotação
POST
https://api.cubosuite.com.br/annotations
Descrição
O autor da anotação será sempre o usuário autenticado.
Se arquivos temporários forem enviados, eles serão movidos para o destino final.
Se vinculada a um negócio (deal), o campo rotten será automaticamente desativado.
Campos obrigatórios
| Campo | Tipo | Descrição |
|---|---|---|
| text | string | Texto da anotação. Campo obrigatório. |
| dealId | number (opcional) | ID do negócio vinculado. Necessário caso organizationId, peopleId e activityId não sejam informados. |
| organizationId | number (opcional) | ID da organização vinculada. Necessário caso os demais não sejam informados. |
| peopleId | number (opcional) | ID da pessoa vinculada. Necessário caso os demais não sejam informados. |
| activityId | number (opcional) | ID da atividade vinculada. Necessário caso os demais não sejam informados. |
| type | enum | Tipo da anotação. Valores possíveis: observation, activity, files, alteration, whatsapp. Obrigatório. |
| urlFiles | array de strings (opcional) | Lista de URLs dos arquivos associados. Arquivos temporários serão movidos. |
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.cubosuite.com.br/annotations' \
--header 'Content-Type: application/json' \
--data-raw '{
"text": "Reunião realizada com o cliente. Análise positiva.",
"dealId": 12,
"type": "activity",
"urlFiles": [
"https://meuarquivo.com/tmp/123.png",
"https://meuarquivo.com/final/456.jpg"
]
}'Response Response Example
200 - Success
{
"id": 90,
"text": "Primeira anotação no negócio",
"type": "observation",
"dealId": 1070,
"userId": 36,
"createdAt": "2021-06-30T20:20:27.000-03:00",
"updatedAt": null,
"deal": {
"id": 1070,
"title": "Prospecção"
},
"user": {
"id": 36,
"name": "Rayssa Assis"
}
}Requisição
Parâmetros Header
Content-Type
string
opcional
Exemplo:
application/json
Parâmetros Bodyapplication/json