Ver .md

custom_objects.record_note_delete

Excluir nota de um registro. Exclui a nota. Só quem escreveu ou um administrador pode excluir.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/custom_objects.record_note_delete (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_delete
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId custom_objects.record_note_delete)

Entrada

CampoTipoObrigatórioNota
recordIdstring (uuid)sim
noteIdstring (uuid)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)$"
    }
  },
  "required": [
    "recordId",
    "noteId"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/custom_objects.record_note_delete \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"recordId":"00000000-0000-0000-0000-000000000000","noteId":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs custom_objects.record_note_delete --json '{"recordId":"00000000-0000-0000-0000-000000000000","noteId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta custom_objects_record_note_delete 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"
    }
  },
  "required": [
    "id"
  ],
  "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).