custom_objects.record_note_update
Editar nota de um registro. Troca o texto da nota. Só quem escreveu a nota ou um administrador pode editar.
- Endpoint:
POST https://app.atomiks.com.br/api/v1/custom_objects.record_note_update(corpo JSON) - Quem pode chamar: membro da conta
- Escopo da chave:
crm:write - Grava dados: sim
- Pela chave de API: sim
- Ferramenta MCP:
custom_objects_record_note_update - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdcustom_objects.record_note_update)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
recordId | string (uuid) | sim | |
noteId | string (uuid) | sim | |
body | string | sim |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"recordId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"noteId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"body": {
"type": "string",
"minLength": 1,
"maxLength": 10000
}
},
"required": [
"recordId",
"noteId",
"body"
]
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/custom_objects.record_note_update \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"recordId":"00000000-0000-0000-0000-000000000000","noteId":"00000000-0000-0000-0000-000000000000","body":"Cliente pediu retorno na segunda."}'CLI:
node cli/atomiks.mjs custom_objects.record_note_update --json '{"recordId":"00000000-0000-0000-0000-000000000000","noteId":"00000000-0000-0000-0000-000000000000","body":"Cliente pediu retorno na segunda."}'MCP: ferramenta custom_objects_record_note_update com a mesma entrada.
Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"recordId": {
"type": "string"
},
"body": {
"type": "string"
},
"authorId": {
"type": [
"string",
"null"
]
},
"authorName": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"recordId",
"body",
"authorId",
"authorName",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}Erros
{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).