GramClaw · Schema

CreateCampaignRequest

TelegramOutreachMarketingAutomationMCP

Properties

Name Type Description
name string
message_text string Supports [[name]] and [[username]], resolved from Telegram for every recipient.
recipients array
steps array Follow-ups. Without branching every step uses branch no_reply (max 5); with branching each step is seen or unseen (max 5 per track).
branching_enabled boolean Seen/unseen branching; rejected unless the independent U4 branching and read-receipt gates are on.
daily_quota_per_account integer
max_followups integer
scheduled_at string Not in the past; at most one year ahead.
schedule_timezone string IANA time zone, default UTC.
View JSON Schema on GitHub

JSON Schema

gramclaw-com-create-campaign-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/gramclaw-com/json-schema/gramclaw-com-create-campaign-request-schema.json",
  "title": "CreateCampaignRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/gramclaw-com-api-openapi.json#/components/schemas/CreateCampaignRequest",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "message_text",
    "recipients"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200
    },
    "message_text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4096,
      "description": "Supports [[name]] and [[username]], resolved from Telegram for every recipient."
    },
    "recipients": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "account_id",
          "chat_id"
        ],
        "properties": {
          "account_id": {
            "type": "string"
          },
          "chat_id": {
            "type": "string",
            "pattern": "^telegram:chat:[0-9]+$"
          }
        }
      }
    },
    "steps": {
      "type": "array",
      "maxItems": 10,
      "description": "Follow-ups. Without branching every step uses branch no_reply (max 5); with branching each step is seen or unseen (max 5 per track).",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "branch",
          "wait_hours",
          "variants"
        ],
        "properties": {
          "branch": {
            "type": "string",
            "enum": [
              "no_reply",
              "seen",
              "unseen"
            ]
          },
          "wait_hours": {
            "type": "number",
            "minimum": 0.0833
          },
          "variants": {
            "type": "array",
            "minItems": 1,
            "maxItems": 5,
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 4096
            }
          }
        }
      }
    },
    "branching_enabled": {
      "type": "boolean",
      "description": "Seen/unseen branching; rejected unless the independent U4 branching and read-receipt gates are on."
    },
    "daily_quota_per_account": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "default": 30
    },
    "max_followups": {
      "type": "integer",
      "minimum": 0,
      "maximum": 5,
      "default": 2
    },
    "scheduled_at": {
      "type": "string",
      "format": "date-time",
      "description": "Not in the past; at most one year ahead."
    },
    "schedule_timezone": {
      "type": "string",
      "description": "IANA time zone, default UTC."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/gramclaw-com-create-campaign-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.