Ver .md

activities_board.set_outcome

Concluir, cancelar ou reabrir uma atividade. done: true conclui; outcome: false marca como não resolvida (tarefa) ou cancelada (reunião) e guarda outcomeNote (o motivo); done: false reabre e limpa o resultado. Sem a migration de atividades, concluir funciona e cancelar responde migration_pendente.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/activities_board.set_outcome (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: crm:write
  • Grava dados: sim
  • Pela chave de API: sim
  • Ferramenta MCP: activities_board_set_outcome
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId activities_board.set_outcome)

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
donebooleansim
outcomeboolean | nullnão
outcomeNotestring | nullnão
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "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)$"
    },
    "done": {
      "type": "boolean"
    },
    "outcome": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "outcomeNote": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "id",
    "done"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/activities_board.set_outcome \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000","done":true,"outcome":true}'

CLI:

node cli/atomiks.mjs activities_board.set_outcome --json '{"id":"00000000-0000-0000-0000-000000000000","done":true,"outcome":true}'

MCP: ferramenta activities_board_set_outcome com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "item": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "enum": [
            "task",
            "appointment"
          ]
        },
        "type": {
          "type": "string",
          "enum": [
            "call",
            "whatsapp",
            "meeting",
            "task",
            "appointment"
          ]
        },
        "title": {
          "type": "string"
        },
        "startAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "endAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "allDay": {
          "type": "boolean"
        },
        "durationMinutes": {
          "type": [
            "number",
            "null"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "open",
            "scheduled",
            "resolved",
            "cancelled",
            "completed"
          ]
        },
        "contactName": {
          "type": [
            "string",
            "null"
          ]
        },
        "contactEmail": {
          "type": [
            "string",
            "null"
          ]
        },
        "contactPhone": {
          "type": [
            "string",
            "null"
          ]
        },
        "leadId": {
          "type": "string"
        },
        "opportunityCardId": {
          "type": [
            "string",
            "null"
          ]
        },
        "opportunityCardTitle": {
          "type": [
            "string",
            "null"
          ]
        },
        "opportunityPipelineId": {
          "type": [
            "string",
            "null"
          ]
        },
        "opportunityPipelineName": {
          "type": [
            "string",
            "null"
          ]
        },
        "notes": {
          "type": [
            "string",
            "null"
          ]
        },
        "meetingLink": {
          "type": [
            "string",
            "null"
          ]
        },
        "guests": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "attendantId": {
          "type": [
            "string",
            "null"
          ]
        },
        "attendantName": {
          "type": [
            "string",
            "null"
          ]
        },
        "outcome": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "outcomeNote": {
          "type": [
            "string",
            "null"
          ]
        },
        "priority": {
          "type": "string",
          "enum": [
            "urgent",
            "high",
            "medium",
            "low",
            "none"
          ]
        },
        "conversationId": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "kind",
        "type",
        "title",
        "startAt",
        "endAt",
        "allDay",
        "durationMinutes",
        "status",
        "contactName",
        "contactEmail",
        "contactPhone",
        "leadId",
        "opportunityCardId",
        "opportunityCardTitle",
        "opportunityPipelineId",
        "opportunityPipelineName",
        "notes",
        "meetingLink",
        "guests",
        "attendantId",
        "attendantName",
        "outcome",
        "outcomeNote",
        "priority",
        "conversationId"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "item"
  ],
  "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).