cadences.runs_start

Aplicar cadência a uma oportunidade. Inicia a cadência (ativa) na oportunidade aberta e cria a tarefa do passo 1 na hora (mesmo que a oportunidade já tenha outra próxima ação aberta). Responsável da tarefa: o dono da oportunidade, ou quem aplicou. Oportunidade que já está em uma cadência (ativa ou pausada) dá limit_reached (409): tire-a da atual antes.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "cadenceId": {
      "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)$"
    },
    "opportunityId": {
      "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": [
    "cadenceId",
    "opportunityId"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs cadences.runs_start --json '{"cadenceId":"00000000-0000-0000-0000-000000000000","opportunityId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta cadences_runs_start 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"
    },
    "cadenceId": {
      "type": "string"
    },
    "cadenceName": {
      "type": "string"
    },
    "opportunityId": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused",
        "completed",
        "exhausted",
        "stopped"
      ]
    },
    "statusReason": {
      "type": [
        "string",
        "null"
      ]
    },
    "phase": {
      "type": [
        "number",
        "null"
      ]
    },
    "phaseName": {
      "type": [
        "string",
        "null"
      ]
    },
    "totalPhases": {
      "type": "number"
    },
    "phaseStep": {
      "type": "number"
    },
    "phaseSteps": {
      "type": "number"
    },
    "currentPosition": {
      "type": "number"
    },
    "totalSteps": {
      "type": "number"
    },
    "currentTaskId": {
      "type": [
        "string",
        "null"
      ]
    },
    "currentTaskTitle": {
      "type": [
        "string",
        "null"
      ]
    },
    "currentTaskStatus": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "open",
            "done"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "nextAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "automatic": {
      "type": "boolean"
    },
    "startedAt": {
      "type": "string"
    },
    "finishedAt": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "cadenceId",
    "cadenceName",
    "opportunityId",
    "status",
    "statusReason",
    "phase",
    "phaseName",
    "totalPhases",
    "phaseStep",
    "phaseSteps",
    "currentPosition",
    "totalSteps",
    "currentTaskId",
    "currentTaskTitle",
    "currentTaskStatus",
    "nextAt",
    "automatic",
    "startedAt",
    "finishedAt"
  ],
  "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).