AtomiksAPI
Ver .md

scheduling.schedule_notifications_set_active

Ativar ou pausar uma notificação. Liga (active true, mode active) ou pausa (mode paused) a notificação sem apagar a configuração. Devolve a notificação.

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

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
activebooleansim
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)$"
    },
    "active": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "active"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs scheduling.schedule_notifications_set_active --json '{"id":"00000000-0000-0000-0000-000000000000","active":false}'

MCP: ferramenta scheduling_schedule_notifications_set_active 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"
    },
    "scheduleId": {
      "type": "string"
    },
    "recipeKey": {
      "type": "string"
    },
    "flowId": {
      "type": [
        "string",
        "null"
      ]
    },
    "mode": {
      "type": "string",
      "enum": [
        "active",
        "paused"
      ]
    },
    "active": {
      "type": "boolean"
    },
    "config": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "id",
    "scheduleId",
    "recipeKey",
    "flowId",
    "mode",
    "active",
    "config"
  ],
  "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).

scheduling.schedule_notifications_set_active · Atomiks API