Ver .md

scheduling.schedule_notifications_update

Editar notificação de uma agenda. Troca a configuração inteira (config, mesmas regras de scheduling.schedule_notifications_create); o estado ativo/pausado não muda.

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

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
configobjectsim
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)$"
    },
    "config": {
      "type": "object",
      "properties": {
        "recipient": {
          "type": "string",
          "enum": [
            "lead",
            "attendant"
          ]
        },
        "direction": {
          "type": "string",
          "enum": [
            "before",
            "after"
          ]
        },
        "offsetMinutes": {
          "type": "integer",
          "minimum": 0,
          "maximum": 525600
        },
        "atTime": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
            },
            {
              "type": "null"
            }
          ]
        },
        "channel": {
          "type": "string",
          "enum": [
            "internal",
            "email",
            "sms",
            "whatsapp",
            "tag"
          ]
        },
        "title": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "message": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 10000
            },
            {
              "type": "null"
            }
          ]
        },
        "emailSubject": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "emailHtml": {
          "type": "boolean"
        },
        "tagIds": {
          "anyOf": [
            {
              "maxItems": 50,
              "type": "array",
              "items": {
                "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)$"
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "gupshupTemplateId": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 100
            },
            {
              "type": "null"
            }
          ]
        },
        "gupshupAppId": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 100
            },
            {
              "type": "null"
            }
          ]
        },
        "templateParams": {
          "anyOf": [
            {
              "maxItems": 50,
              "type": "array",
              "items": {}
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "recipient",
        "direction",
        "offsetMinutes",
        "channel"
      ]
    }
  },
  "required": [
    "id",
    "config"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/scheduling.schedule_notifications_update \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000","config":{"recipient":"attendant","direction":"before","offsetMinutes":15,"channel":"internal","title":"Reunião em 15 min","message":"Prepare-se."}}'

CLI:

node cli/atomiks.mjs scheduling.schedule_notifications_update --json '{"id":"00000000-0000-0000-0000-000000000000","config":{"recipient":"attendant","direction":"before","offsetMinutes":15,"channel":"internal","title":"Reunião em 15 min","message":"Prepare-se."}}'

MCP: ferramenta scheduling_schedule_notifications_update 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_update · Atomiks API