flows.test_run

Testar flow num contato. Inicia um run do flow publicado no contato escolhido, ignorando os gatilhos. Falha se o contato já está no flow.

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

Entrada

{
  "$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)$"
    },
    "contactId": {
      "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": [
    "id",
    "contactId"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs flows.test_run --json '{"id":"00000000-0000-0000-0000-000000000000","contactId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta flows_test_run 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"
    },
    "runId": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "runId"
  ],
  "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).