Neuron

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "botId",
    "channelId"
  ],
  "properties": {
    "botId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot"
    },
    "channelId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the WhatsApp channel to connect"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "group"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Keep only contacts carrying one of these tags"
    },
    "group": {
      "type": "string",
      "description": "Group id, slug, or JID (ending in @g.us)"
    },
    "phones": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Raw phone numbers, e.g. pasted from a CSV"
    },
    "listIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Contact list ids or slugs — pulls every member"
    },
    "contactIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Existing contact ids"
    },
    "allContacts": {
      "type": "boolean",
      "description": "Union the org's entire address book"
    },
    "fromGroupIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Copy/combine members live from these WhatsApp group JIDs"
    },
    "excludeListIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Subtract every member of these lists"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "The address to invite"
    },
    "label": {
      "type": "string",
      "maxLength": 100,
      "description": "A name for it, e.g. 'Accountant'"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "codes"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Product UUID"
    },
    "codes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "description": "Unique codes/keys to append to the pool"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "idOrSlug",
    "entries"
  ],
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "phone": {
            "type": "string",
            "description": "Phone number in E.164 format (e.g., +2348012345678). Creates a new contact if no match exists."
          },
          "contactId": {
            "type": "string",
            "description": "Unique identifier (UUID) of an existing contact"
          }
        },
        "additionalProperties": false
      },
      "description": "Array of contacts to add, each identified by contactId or phone number"
    },
    "idOrSlug": {
      "type": "string",
      "description": "Unique identifier (UUID) or URL-friendly slug of the target contact list"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "usernames"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "usernames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 1000,
      "minItems": 1
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "key",
    "value"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the tool to add the secret to"
    },
    "key": {
      "type": "string",
      "description": "Secret key name used in templates (e.g., 'API_KEY', 'AUTH_TOKEN')"
    },
    "value": {
      "type": "string",
      "description": "Secret value to store securely (will be encrypted)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "botId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Persona UUID"
    },
    "botId": {
      "type": "string",
      "description": "Bot UUID to apply the voice to."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "pitch": {
      "type": "string",
      "description": "Short note on what you plan to sell"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the reflection to approve"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "botId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the channel"
    },
    "botId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot to assign"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "botId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the social channel"
    },
    "botId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot to assign"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "knowledgeBaseId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot"
    },
    "priority": {
      "type": "number",
      "description": "Priority level for knowledge base retrieval (higher values are checked first)"
    },
    "knowledgeBaseId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the knowledge base to attach"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "audioBase64"
  ],
  "properties": {
    "audioBase64": {
      "type": "string",
      "description": "Base64-encoded audio data containing spoken contact information"
    },
    "audioFormat": {
      "type": "string",
      "default": "webm",
      "description": "Audio format hint for decoding (default: 'webm')"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "channelId",
    "jid"
  ],
  "properties": {
    "jid": {
      "type": "string",
      "description": "Contact JID or phone number to block (e.g. '2348012345678' or '[email protected]')"
    },
    "channelId": {
      "type": "string",
      "description": "WhatsApp channel identifier (UUID)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "apiKey",
    "message",
    "contactPhone"
  ],
  "properties": {
    "apiKey": {
      "type": "string",
      "description": "Bot API key with 'nrn_' prefix for authentication"
    },
    "message": {
      "type": "string",
      "description": "The message text to send to the bot"
    },
    "contactName": {
      "type": "string",
      "description": "Display name of the contact for conversation context"
    },
    "contactPhone": {
      "type": "string",
      "description": "Phone number of the contact sending the message (E.164 format, e.g., '+2348012345678')"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "apiKey"
  ],
  "properties": {
    "apiKey": {
      "type": "string",
      "description": "Bot API key with 'nrn_' prefix for authentication"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "apiKey",
    "conversationId"
  ],
  "properties": {
    "limit": {
      "type": "number",
      "description": "Maximum number of messages to return (default: 50)",
      "exclusiveMinimum": 0
    },
    "apiKey": {
      "type": "string",
      "description": "Bot API key with 'nrn_' prefix for authentication"
    },
    "before": {
      "type": "string",
      "description": "Cursor for pagination — retrieve messages created before this message ID or ISO 8601 timestamp"
    },
    "conversationId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the conversation to retrieve messages from"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "apiKey"
  ],
  "properties": {
    "page": {
      "type": "number",
      "description": "Page number for pagination (default: 1)",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "number",
      "description": "Number of conversations per page (default: 20)",
      "exclusiveMinimum": 0
    },
    "apiKey": {
      "type": "string",
      "description": "Bot API key with 'nrn_' prefix for authentication"
    },
    "status": {
      "type": "string",
      "description": "Filter by conversation status: 'active', 'closed', or 'pending'"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "apiKey",
    "to",
    "message"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "Recipient's phone number (E.164 format, e.g., '+2348012345678')"
    },
    "apiKey": {
      "type": "string",
      "description": "Bot API key with 'nrn_' prefix for authentication"
    },
    "sendAt": {
      "type": "string",
      "description": "ISO 8601 date-time for scheduled delivery (e.g., '2025-12-31T10:00:00Z'). Message sends immediately if omitted."
    },
    "message": {
      "type": "string",
      "description": "The message text to send to the recipient"
    },
    "mediaUrl": {
      "type": "string",
      "description": "Public URL of the media file to attach (required for non-text message types)"
    },
    "channelId": {
      "type": "string",
      "description": "Unique identifier (UUID) of a specific WhatsApp channel to send from. Uses the bot's primary channel if omitted."
    },
    "messageType": {
      "type": "string",
      "description": "Type of message to send: 'text', 'image', 'video', 'audio', or 'document' (default: 'text')"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "number",
      "description": "Page number for pagination (default: 1)"
    },
    "limit": {
      "type": "number",
      "description": "Number of items per page (default: 20)"
    },
    "region": {
      "type": "string",
      "description": "Filter by geographic region (e.g., 'lagos', 'abuja')"
    },
    "search": {
      "type": "string",
      "description": "Search term to filter by description or category"
    },
    "category": {
      "type": "string",
      "description": "Filter by audience category (e.g., 'delivery', 'tech', 'consumers')"
    },
    "smsEnabled": {
      "type": "boolean",
      "description": "Only return lists whose owner opted into SMS campaigns (usable as curated audiences for neuron_create_sms_campaign)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "number",
      "description": "Page number for pagination (default: 1)"
    },
    "tags": {
      "type": "string",
      "description": "Filter by tags (comma-separated list, e.g., 'ai,chatbot')"
    },
    "type": {
      "enum": [
        "knowledge_base",
        "bot_template",
        "tool_template",
        "reflection_pack"
      ],
      "type": "string",
      "description": "Filter by resource type"
    },
    "limit": {
      "type": "number",
      "description": "Number of items per page (default: 20)"
    },
    "query": {
      "type": "string",
      "description": "Free-text search query to filter pool items by name or description"
    },
    "category": {
      "type": "string",
      "description": "Filter by category name"
    },
    "featured": {
      "type": "boolean",
      "description": "When true, return only featured items"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "collectionId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Persona name. Defaults to '<collection name> voice'."
    },
    "sampleLimit": {
      "type": "integer",
      "maximum": 200,
      "minimum": 1,
      "description": "How many top-engagement items to analyze (default 40)."
    },
    "collectionId": {
      "type": "string",
      "description": "Source Collection UUID (built by the web agent / content mining)."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "conversationId"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "maximum": 500,
      "minimum": 1,
      "description": "How many recent messages to read (default 200)."
    },
    "author": {
      "enum": [
        "me",
        "contact",
        "bot",
        "any"
      ],
      "type": "string",
      "description": "Whose voice to capture. Default 'me'."
    },
    "senderName": {
      "type": "string",
      "description": "For groups: match one participant by display name."
    },
    "senderPhone": {
      "type": "string",
      "description": "For groups: match one participant by phone."
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation UUID (from neuron_list_conversations)."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "name": {
      "type": "string",
      "description": "Persona name. Defaults to '<author> voice' or 'Custom voice'."
    },
    "text": {
      "type": "string",
      "description": "A raw blob to distill: posts, a dialogue, a chat transcript, or a writing sample. Auto-split into samples."
    },
    "samples": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Pre-split writing samples (alternative or addition to `text`)."
    },
    "speaker": {
      "type": "string",
      "description": "If `text` is a chat transcript, keep only this speaker's lines (name match) — so a group chat yields one person's voice."
    },
    "platform": {
      "type": "string",
      "description": "Optional metadata tag for the samples (e.g. 'whatsapp', 'x')."
    },
    "authorLabel": {
      "type": "string",
      "description": "Who the voice belongs to, for a more grounded analysis."
    },
    "description": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "botId",
    "settings"
  ],
  "properties": {
    "botId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot to update tools for"
    },
    "settings": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "toolId",
          "enabled"
        ],
        "properties": {
          "toolId": {
            "type": "string",
            "description": "Identifier of the built-in tool (e.g., 'web_search', 'send_direct_message')"
          },
          "enabled": {
            "type": "boolean",
            "description": "Whether to enable (true) or disable (false) this tool"
          }
        },
        "additionalProperties": false
      },
      "description": "Array of tool toggle settings to apply in bulk"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number for pagination (default: 1)",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "description": "Number of campaigns per page (default: 20)",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the campaign you own"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "apiKey",
    "approvalId"
  ],
  "properties": {
    "apiKey": {
      "type": "string",
      "description": "Bot API key with 'nrn_' prefix for authentication"
    },
    "reason": {
      "type": "string",
      "description": "Optional cancellation reason"
    },
    "approvalId": {
      "type": "string",
      "description": "The approval request id (UUID) to cancel"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Booking UUID"
    },
    "reason": {
      "type": "string",
      "description": "Cancellation reason"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "runId"
  ],
  "properties": {
    "runId": {
      "type": "string",
      "description": "UUID of the run to cancel."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the scheduled message to cancel"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "plan"
  ],
  "properties": {
    "plan": {
      "enum": [
        "pro",
        "business"
      ],
      "type": "string",
      "description": "Subscription plan to purchase: 'pro' or 'business'"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "execute": {
      "type": "boolean",
      "description": "Actually clear. Default false = preview only."
    },
    "chatKind": {
      "enum": [
        "all",
        "dm",
        "group"
      ],
      "type": "string",
      "description": "DMs, groups, or both (default both)."
    },
    "mediaTypes": {
      "type": "array",
      "items": {
        "enum": [
          "image",
          "video",
          "audio",
          "document",
          "sticker"
        ],
        "type": "string"
      },
      "description": "Only these media types (media clears only)."
    },
    "confirmChats": {
      "type": "integer",
      "description": "Required for workspace-wide clears: the 'conversations' number from the preview."
    },
    "alsoBotMemory": {
      "type": "boolean",
      "description": "Also clear what the bot learned from these chats (insights, conversation summary)."
    },
    "olderThanDays": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0
        },
        {
          "type": "null"
        }
      ],
      "description": "Only messages older than this many days. Omit/null for all ages."
    },
    "conversationIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Limit to these conversations. Omit for the whole workspace."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "execute": {
      "type": "boolean",
      "description": "Actually remove. Default false = preview only."
    },
    "chatKind": {
      "enum": [
        "all",
        "dm",
        "group"
      ],
      "type": "string",
      "description": "DMs, groups, or both (default both)."
    },
    "mediaTypes": {
      "type": "array",
      "items": {
        "enum": [
          "image",
          "video",
          "audio",
          "document",
          "sticker"
        ],
        "type": "string"
      },
      "description": "Only these media types (media clears only)."
    },
    "olderThanDays": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0
        },
        {
          "type": "null"
        }
      ],
      "description": "Only messages older than this many days. Omit/null for all ages."
    },
    "conversationIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Limit to these conversations. Omit for the whole workspace."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the conversation to close"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Booking UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "channelId",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "Recipient phone number (E.164 format, e.g., '2348012345678')"
    },
    "text": {
      "type": "string",
      "description": "Message text content (optional when sending a template)"
    },
    "sendAt": {
      "type": "string",
      "description": "ISO 8601 date-time for scheduled delivery (e.g., '2025-12-31T10:00:00Z'). Message sends immediately if omitted."
    },
    "mediaUrl": {
      "type": "string",
      "description": "URL of media to attach (required for non-text message types)"
    },
    "template": {
      "type": "object",
      "required": [
        "name",
        "language"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Template name exactly as approved (see neuron_list_whatsapp_templates)"
        },
        "language": {
          "type": "string",
          "description": "Template language code, e.g. 'en_US'"
        },
        "components": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": {}
          },
          "description": "Meta send-time components with variable values, e.g. [{ type: 'body', parameters: [{ type: 'text', text: 'Ada' }] }]. Omit for templates without variables."
        }
      },
      "description": "Approved template (official WhatsApp Business API sessions only). Required to reach anyone who hasn't messaged you in the last 24 hours. Set messageType to 'template'.",
      "additionalProperties": false
    },
    "channelId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the WhatsApp channel to send through"
    },
    "contactName": {
      "type": "string",
      "description": "Display name for the recipient contact"
    },
    "messageType": {
      "type": "string",
      "description": "Type of message: 'text' (default), 'image', 'document', or 'template' (official API sessions)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Booking UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Lead UUID"
    },
    "addToList": {
      "type": "string",
      "description": "Contact list name to add the converted contact to."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "message",
    "targetDemographics",
    "targetGoal",
    "budget"
  ],
  "properties": {
    "budget": {
      "type": "number",
      "description": "Total ad budget in kobo (e.g., 500000 = NGN 5,000)"
    },
    "message": {
      "type": "string",
      "description": "The ad message content to distribute to matched contacts"
    },
    "mediaUrl": {
      "type": "string",
      "description": "Media URL for non-text messages (required when messageType is 'image', 'video', or 'document')"
    },
    "targetGoal": {
      "type": "number",
      "description": "Target number of successful message deliveries"
    },
    "messageType": {
      "type": "string",
      "description": "Message content type: 'text', 'image', 'video', or 'document' (default: 'text')"
    },
    "targetDemographics": {
      "type": "object",
      "properties": {
        "regions": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Target geographic regions to match (e.g., ['lagos', 'abuja'])"
        },
        "categories": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Target audience categories to match (e.g., ['delivery', 'tech'])"
        }
      },
      "description": "Demographic criteria to match against pool list entries",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "botId",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Descriptive name for the API key to identify its purpose (e.g., 'Production CRM Integration')"
    },
    "botId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot to create the API key for"
    },
    "expiresAt": {
      "type": "string",
      "description": "ISO 8601 date-time when the key should expire (e.g., '2026-12-31T23:59:59Z'). Key never expires if omitted."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "title",
    "authorType"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of tag names or slugs to categorize the post"
    },
    "title": {
      "type": "string",
      "description": "Title of the blog post (max 500 characters)"
    },
    "blocks": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": {}
      },
      "description": "Structured layout blocks, rendered top-to-bottom as styled components. Each block is an object with a `type` and its fields:\n- hero: { type:'hero', title, kicker?, subtitle?, imageUrl?, align?:'left'|'center', ctaLabel?, ctaHref? }\n- richText: { type:'richText', markdown }  (full GFM markdown)\n- callout: { type:'callout', variant:'info'|'tip'|'warning'|'success'|'danger', title?, markdown }\n- columns: { type:'columns', ratio?:'1-1'|'1-2'|'2-1', columns:[ [block,...], [block,...] ] }  (exactly 2 columns of leaf blocks; no nested columns)\n- codeCard: { type:'codeCard', language?, filename?, code }\n- imageGrid: { type:'imageGrid', columns?:1|2|3|4, images:[{ url, alt?, caption? }] }\n- quote: { type:'quote', quote, attribution? }\n- embed: { type:'embed', provider:'youtube'|'loom'|'vimeo'|'generic', url, title? }  (paste the normal share URL)\n- cta: { type:'cta', headline, body?, buttonLabel, buttonHref, secondaryLabel?, secondaryHref?, accent?:'#hex' }\n- divider: { type:'divider' }\n- html: { type:'html', html, sandboxed?, height? }  (custom HTML. Default is sanitized + indexable, no scripts. Set sandboxed:true to run scripts inside an isolated iframe — NOT indexed by search.)\nBuild magazine-style posts by composing these, e.g. a hero, then richText, then a columns block, a callout, a codeCard, and a closing cta."
    },
    "status": {
      "enum": [
        "draft",
        "published"
      ],
      "type": "string",
      "default": "draft",
      "description": "Initial publication status of the post (default: 'draft')"
    },
    "content": {
      "type": "string",
      "description": "Optional markdown body (GFM + inline raw HTML). Used when `blocks` is not provided, and kept as a fallback when it is. Rich options: ![alt](url), <video src controls>, <iframe> embeds (16:9), <details><summary>, <mark>, <kbd>."
    },
    "excerpt": {
      "type": "string",
      "description": "Short summary or preview text for the blog post"
    },
    "seoTitle": {
      "type": "string",
      "description": "Custom SEO title override for search engine results"
    },
    "authorType": {
      "enum": [
        "user",
        "organization"
      ],
      "type": "string",
      "description": "Whether the post is authored by an individual user or the organization"
    },
    "seoKeywords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of SEO keywords for search engine optimization"
    },
    "coverImageUrl": {
      "type": "string",
      "description": "URL of the cover image displayed at the top of the post"
    },
    "seoDescription": {
      "type": "string",
      "description": "Meta description for search engine result snippets"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name",
    "systemPrompt"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name for the bot"
    },
    "llmModel": {
      "type": "string",
      "description": "OpenRouter model ID (e.g., 'deepseek/deepseek-v4.1-flash' (default), 'google/gemini-2.5-flash')"
    },
    "metadata": {
      "type": "object",
      "description": "Arbitrary metadata object stored with the bot. Known keys: 'communityExitFollowUp' (auto-DM users who leave watched groups — { enabled: boolean, groupJids: string[], message: string with {name} placeholder }), 'learningConfig' (self-learning from conversations — { enabled: boolean, folder: string, groupChats: string[], dmPhones: string[], useAdminPhones: boolean }), 'loadBalancing' (multi-channel round-robin — { enabled: boolean, strategy: string }), 'welcomeNewMembers' (fine-tune welcome behavior — { batchWindowSeconds: number, groupJids: string[] }). Additional custom keys are preserved as-is.",
      "additionalProperties": {}
    },
    "maxTokens": {
      "type": "number",
      "description": "Maximum number of tokens the bot can generate per response",
      "exclusiveMinimum": 0
    },
    "assignment": {
      "type": "string",
      "description": "One-sentence role definition for the bot (max 2000 chars)"
    },
    "systemPrompt": {
      "type": "string",
      "description": "System prompt that defines the bot's behavior, personality, and response guidelines"
    },
    "throttleMode": {
      "enum": [
        "hold",
        "drop"
      ],
      "type": "string",
      "description": "While paused: 'hold' (default) queues sends and delivers them when safe — the bot API returns success with throttle.status 'held'; 'drop' refuses them — the bot API returns 429 THROTTLED with Retry-After."
    },
    "llmTemperature": {
      "type": "number",
      "maximum": 2,
      "minimum": 0,
      "description": "Temperature parameter controlling response randomness (0 = deterministic, 2 = creative)"
    },
    "welcomeMessage": {
      "type": "string",
      "description": "Welcome message sent to new members joining groups the bot manages. Setting this field activates the batched welcome feature — new members are accumulated over a window (default 60s) and welcomed in a single message with @mentions. Set to null to disable."
    },
    "fallbackMessage": {
      "type": "string",
      "description": "Message sent when the bot cannot understand user input (max 2000 chars)"
    },
    "greetingMessage": {
      "type": "string",
      "description": "Automatic greeting sent when a new conversation starts (max 2000 chars)"
    },
    "throttleEnabled": {
      "type": "boolean",
      "description": "\"Protect my number\": slow down, then pause, the bot's proactive WhatsApp sends (API, flows, tasks) when the number nears volume that gets numbers suspended, and resume automatically. Replies to inbound messages are never held. WhatsApp doesn't publish its limits: these are conservative estimates that cut the risk but can't guarantee no suspension; content and spam reports matter as much as volume."
    },
    "escalationPrompt": {
      "type": "string",
      "description": "Prompt template used when escalating to a human agent (max 5000 chars)"
    },
    "responsibilities": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of responsibility descriptions defining what the bot handles"
    },
    "throttleHoldHours": {
      "type": "integer",
      "maximum": 72,
      "minimum": 1,
      "description": "Hold mode: give up on a held message after this many hours (default 24); it then appears under failed messages."
    },
    "whatsappChannelId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the WhatsApp channel to associate with the bot"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name or label for the broadcast"
    },
    "botId": {
      "type": "string",
      "description": "Identifier (UUID) of a bot to send through. Each recipient's channel is picked by the bot's load-balancer + sticky sessions. Takes precedence over channelId."
    },
    "message": {
      "type": "string",
      "description": "Message content to broadcast to recipients (optional when sending a template)"
    },
    "mediaUrl": {
      "type": "string",
      "description": "URL of media to attach (required for image or document message types)"
    },
    "template": {
      "type": "object",
      "required": [
        "name",
        "language"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Template name exactly as approved (see neuron_list_whatsapp_templates)"
        },
        "language": {
          "type": "string",
          "description": "Template language code, e.g. 'en_US'"
        },
        "components": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": {}
          },
          "description": "Meta send-time components with variable values, e.g. [{ type: 'body', parameters: [{ type: 'text', text: 'Ada' }] }]. Omit for templates without variables."
        }
      },
      "description": "Approved template (official WhatsApp Business API sessions only). On official API sessions, use one for broadcasts: most recipients won't have messaged you in the last 24 hours, and only templates reach them. Set messageType to 'template'.",
      "additionalProperties": false
    },
    "channelId": {
      "type": "string",
      "description": "Identifier (UUID) of the WhatsApp channel to send through (auto-resolved from default channel if omitted)"
    },
    "recipients": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "phone"
        ],
        "properties": {
          "phone": {
            "type": "string",
            "description": "Recipient phone number in E.164 format (e.g., '+2348012345678')"
          },
          "contactName": {
            "type": "string",
            "description": "Display name of the recipient contact"
          }
        },
        "additionalProperties": false
      },
      "description": "Direct list of recipients (alternative to recipientSources)"
    },
    "messageType": {
      "type": "string",
      "description": "Type of message to send (e.g., 'text', 'image', 'document', or 'template' on official API sessions)"
    },
    "scheduledAt": {
      "type": "string",
      "description": "ISO 8601 date-time for scheduled broadcast delivery (e.g., '2025-12-31T10:00:00Z'). Creates as draft if omitted."
    },
    "recipientSources": {
      "type": "object",
      "properties": {
        "phones": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Individual phone numbers in E.164 format to include"
        },
        "filters": {
          "type": "object",
          "properties": {
            "tags": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Only include contacts matching these tags"
            }
          },
          "description": "Additional filters to narrow down recipients",
          "additionalProperties": false
        },
        "listIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Contact list identifiers (UUIDs or slugs) to include as recipients"
        },
        "excludeListIds": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Contact list identifiers (UUIDs or slugs) to exclude from recipients"
        }
      },
      "description": "Resolve recipients dynamically from contact lists with filtering and exclusion",
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Calendar display name"
    },
    "slug": {
      "type": "string",
      "description": "URL slug (auto-generated from name if omitted)"
    },
    "color": {
      "type": "string",
      "description": "Hex color code (e.g. '#6366f1')"
    },
    "timezone": {
      "type": "string",
      "description": "IANA timezone (default: Africa/Lagos)"
    },
    "visibility": {
      "enum": [
        "private",
        "public",
        "org-link"
      ],
      "type": "string",
      "description": "Visibility: 'public' for public booking page, 'org-link' for link-only, 'private' for no public access"
    },
    "description": {
      "type": "string",
      "description": "Calendar description"
    },
    "notifyEmail": {
      "type": "boolean",
      "description": "Send email notifications for bookings"
    },
    "notifyPhone": {
      "type": "string",
      "description": "Host phone number for WhatsApp notifications"
    },
    "notifyWhatsapp": {
      "type": "boolean",
      "description": "Send WhatsApp notifications for bookings"
    },
    "notifyEmailAddress": {
      "type": "string",
      "description": "Host email address for notifications"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "title",
    "message",
    "rewardPerDelivery",
    "totalBudget",
    "deadline"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "Campaign title displayed in marketplace and dashboard"
    },
    "message": {
      "type": "string",
      "description": "The WhatsApp message template to send to contacts"
    },
    "deadline": {
      "type": "string",
      "description": "Campaign deadline in ISO 8601 date format (e.g., '2025-12-31')"
    },
    "guidelines": {
      "type": "string",
      "description": "Instructions and guidelines for campaign participants"
    },
    "description": {
      "type": "string",
      "description": "Campaign description shown in the marketplace listing"
    },
    "totalBudget": {
      "type": "number",
      "description": "Total campaign budget in kobo (e.g., 500000 = NGN 5,000)"
    },
    "rewardPerDelivery": {
      "type": "number",
      "description": "Reward per successful delivery in kobo (e.g., 5000 = NGN 50)"
    },
    "requireMutualContact": {
      "type": "boolean",
      "description": "Only allow sends to contacts who have previously responded (default: false)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name",
    "type"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name for the channel"
    },
    "type": {
      "enum": [
        "meta_cloud",
        "baileys"
      ],
      "type": "string",
      "description": "Integration type: 'meta_cloud' for Meta Cloud API or 'baileys' for direct WhatsApp connection"
    },
    "phoneNumber": {
      "type": "string",
      "description": "Phone number for the channel (E.164 format, e.g., '+2348012345678')"
    },
    "metaAccessToken": {
      "type": "string",
      "description": "Meta Access Token (required for meta_cloud type)"
    },
    "metaPhoneNumberId": {
      "type": "string",
      "description": "Meta Phone Number ID (required for meta_cloud type)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name",
    "phone"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Full name of the contact"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Tags to categorize the contact (e.g., ['vendor', 'lagos'])"
    },
    "email": {
      "type": "string",
      "description": "Email address of the contact"
    },
    "notes": {
      "type": "string",
      "description": "Additional notes about the contact, saved as a structured entry"
    },
    "phone": {
      "type": "string",
      "description": "Contact phone number in E.164 format (e.g., +2348012345678)"
    },
    "doNotBroadcast": {
      "type": "boolean",
      "description": "If true, this contact is permanently excluded from all broadcasts"
    },
    "doNotAutoRespond": {
      "type": "boolean",
      "description": "If true, the bot will never auto-respond to this contact (manual/API and human sends still work)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name for the contact list"
    },
    "slug": {
      "type": "string",
      "description": "URL-friendly identifier (auto-generated from name if omitted)"
    },
    "type": {
      "enum": [
        "static",
        "dynamic",
        "merged"
      ],
      "type": "string",
      "description": "List type (default: 'static')"
    },
    "criteria": {
      "type": "object",
      "description": "Dynamic list criteria object: { rules?: { operator, conditions }, aiPrompt?, aiMaxResults? }",
      "additionalProperties": {}
    },
    "description": {
      "type": "string",
      "description": "Human-readable description of the list's purpose"
    },
    "refreshSchedule": {
      "enum": [
        "manual",
        "daily",
        "weekly",
        "on_access"
      ],
      "type": "string",
      "description": "Refresh schedule for dynamic lists (default: 'manual')"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "calendarId",
    "title",
    "startTime",
    "endTime"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "Event title"
    },
    "endTime": {
      "type": "string",
      "description": "End time (ISO 8601)"
    },
    "attendees": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Attendee name"
          },
          "email": {
            "type": "string",
            "description": "Attendee email"
          },
          "phone": {
            "type": "string",
            "description": "Attendee phone (for WhatsApp invitations)"
          },
          "contactId": {
            "type": "string",
            "description": "Link to existing Neuron contact UUID"
          }
        },
        "additionalProperties": false
      },
      "description": "List of attendees to invite"
    },
    "startTime": {
      "type": "string",
      "description": "Start time (ISO 8601, e.g. '2025-03-15T09:00:00Z')"
    },
    "calendarId": {
      "type": "string",
      "description": "Calendar UUID"
    },
    "description": {
      "type": "string",
      "description": "Event description"
    },
    "locationType": {
      "enum": [
        "video",
        "phone",
        "in_person",
        "whatsapp",
        "custom"
      ],
      "type": "string",
      "description": "Location type"
    },
    "locationValue": {
      "type": "string",
      "description": "Location details"
    },
    "recurrenceRule": {
      "anyOf": [
        {
          "type": "object",
          "required": [
            "kind"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "const": "daily"
            },
            "count": {
              "type": "number",
              "description": "Max occurrences"
            },
            "endAt": {
              "type": "string",
              "description": "Stop generating after this ISO date"
            },
            "interval": {
              "type": "number",
              "description": "Every N days (default: 1)"
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "kind",
            "days"
          ],
          "properties": {
            "days": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "Days of week: 0=Sun, 1=Mon, ..., 6=Sat"
            },
            "kind": {
              "type": "string",
              "const": "weekly"
            },
            "count": {
              "type": "number",
              "description": "Max occurrences"
            },
            "endAt": {
              "type": "string",
              "description": "Stop generating after this ISO date"
            },
            "interval": {
              "type": "number",
              "description": "Every N weeks (default: 1)"
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "kind",
            "dayOfMonth"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "const": "monthly"
            },
            "count": {
              "type": "number",
              "description": "Max occurrences"
            },
            "endAt": {
              "type": "string",
              "description": "Stop generating after this ISO date"
            },
            "interval": {
              "type": "number",
              "description": "Every N months (default: 1)"
            },
            "dayOfMonth": {
              "type": "number",
              "description": "Day of month (1-31)"
            }
          },
          "additionalProperties": false
        }
      ],
      "description": "Recurrence rule — generates instances 12 weeks ahead"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "calendarId",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Event type name (e.g. 'Discovery Call')"
    },
    "color": {
      "type": "string",
      "description": "Hex color code"
    },
    "price": {
      "type": "number",
      "description": "Price for paid bookings"
    },
    "currency": {
      "type": "string",
      "description": "3-letter currency code (e.g. 'NGN')"
    },
    "duration": {
      "type": "number",
      "description": "Duration in minutes (default: 30)"
    },
    "minNotice": {
      "type": "number",
      "description": "Minimum notice in minutes before booking"
    },
    "calendarId": {
      "type": "string",
      "description": "Calendar UUID to add the event type to"
    },
    "maxAdvance": {
      "type": "number",
      "description": "Maximum advance booking in minutes"
    },
    "bufferAfter": {
      "type": "number",
      "description": "Buffer minutes after each booking"
    },
    "description": {
      "type": "string",
      "description": "Description shown on the booking page"
    },
    "bufferBefore": {
      "type": "number",
      "description": "Buffer minutes before each booking"
    },
    "locationType": {
      "enum": [
        "video",
        "phone",
        "in_person",
        "whatsapp",
        "custom"
      ],
      "type": "string",
      "description": "Meeting location type"
    },
    "slotInterval": {
      "type": "number",
      "description": "Slot interval in minutes (default: 15)"
    },
    "locationValue": {
      "type": "string",
      "description": "Location details (URL, address, phone)"
    },
    "reminderMinutes": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Array of reminder times in minutes before event (e.g. [1440, 60])"
    },
    "requireConfirmation": {
      "type": "boolean",
      "description": "Require host confirmation for new bookings"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Human-readable name for the flow."
    },
    "graph": {
      "type": "object",
      "required": [
        "nodes",
        "edges"
      ],
      "properties": {
        "edges": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "source",
              "target"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique edge id, e.g. 'e_msg_reply'."
              },
              "source": {
                "type": "string",
                "description": "Source node id."
              },
              "target": {
                "type": "string",
                "description": "Target node id."
              },
              "sourceHandle": {
                "type": "string",
                "description": "Which output port of the source node this edge leaves from. Branch nodes use 'true'/'false', switch/router use case ids, wait nodes use 'default'/'timeout', lookup uses 'found'/'not_found'. Defaults to 'default'."
              }
            },
            "additionalProperties": false
          },
          "description": "Array of edges connecting nodes. Each edge fires when its source node emits on the matching sourceHandle."
        },
        "nodes": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "type"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "Stable node id unique within the flow, e.g. 'n_a1b2' or 't_msg'."
              },
              "type": {
                "type": "string",
                "description": "Registry key — e.g. 'trigger.message_received', 'logic.branch', 'action.send_message'. Use neuron_get_flow_catalog to see all available types."
              },
              "label": {
                "type": "string",
                "description": "Human label overriding the registry default."
              },
              "config": {
                "type": "object",
                "default": {},
                "description": "Node-specific configuration. Values may contain {{…}} templates resolved at runtime against trigger, vars, and nodes.",
                "additionalProperties": {}
              },
              "position": {
                "type": "object",
                "required": [
                  "x",
                  "y"
                ],
                "properties": {
                  "x": {
                    "type": "number"
                  },
                  "y": {
                    "type": "number"
                  }
                },
                "description": "Canvas position (UI layout). Use x=300 as center, space nodes ~160px apart vertically.",
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          },
          "description": "Array of flow nodes."
        }
      },
      "description": "The flow graph — nodes and edges. Omit to create an empty flow (edit later in the UI).",
      "additionalProperties": false
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the flow should be active immediately (default: false)."
    },
    "description": {
      "type": "string",
      "description": "Optional description of what the flow does."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "subject"
  ],
  "properties": {
    "slug": {
      "type": "string",
      "description": "Optional org-unique handle (lowercase letters, numbers, hyphens)"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Keep only contacts carrying one of these tags"
    },
    "phones": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Raw phone numbers, e.g. pasted from a CSV"
    },
    "listIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Contact list ids or slugs — pulls every member"
    },
    "subject": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Group name"
    },
    "ifExists": {
      "enum": [
        "return",
        "error"
      ],
      "type": "string",
      "description": "When the slug is already taken: 'error' (default) fails, 'return' returns the existing group and adds any given members to it (idempotent create)."
    },
    "channelId": {
      "type": "string",
      "description": "Session (connected WhatsApp number) UUID. Omit to use the default."
    },
    "contactIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Existing contact ids"
    },
    "allContacts": {
      "type": "boolean",
      "description": "Union the org's entire address book"
    },
    "description": {
      "type": "string",
      "description": "Optional group description"
    },
    "fromGroupIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Copy/combine members live from these WhatsApp group JIDs"
    },
    "excludeListIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Subtract every member of these lists"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "List name, e.g. 'Giveaway entrants'"
    },
    "description": {
      "type": "string",
      "maxLength": 500
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "title",
    "content"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the knowledge base"
    },
    "title": {
      "type": "string",
      "description": "Title of the entry"
    },
    "folder": {
      "type": "string",
      "description": "Folder to organize the entry: 'general', 'skills', 'contexts', 'documents', or 'faqs' (default: general)"
    },
    "source": {
      "enum": [
        "manual",
        "document",
        "url"
      ],
      "type": "string",
      "description": "Source type of the entry (default: manual)"
    },
    "content": {
      "type": "string",
      "description": "Content or body of the entry"
    },
    "metadata": {
      "type": "object",
      "description": "Optional metadata key-value pairs for the entry",
      "additionalProperties": {}
    },
    "expiresAt": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the entry stops being true (ISO 8601 with offset, e.g. 2026-10-16T23:59:59+05:00). The bot ignores it afterwards and it is deleted within the hour. Null clears it."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the knowledge base"
    },
    "description": {
      "type": "string",
      "description": "Optional description of the knowledge base purpose"
    },
    "rootInstruction": {
      "type": "string",
      "description": "Optional root instruction or context for the knowledge base"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name",
    "type"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "enum": [
        "csv",
        "text_paste",
        "document",
        "web_scrape",
        "tool_output",
        "instagram",
        "x",
        "facebook",
        "tiktok",
        "stream"
      ],
      "type": "string",
      "description": "Lead source type. facebook = Meta Ads Library advertisers; web/IG/X/FB scraping needs DeepAPI configured; TikTok has no native provider (use tool_output)."
    },
    "config": {
      "type": "object",
      "additionalProperties": {}
    },
    "enabled": {
      "type": "boolean"
    },
    "schedule": {
      "type": "object",
      "additionalProperties": {}
    },
    "timezone": {
      "type": "string"
    },
    "scheduleKind": {
      "enum": [
        "cron",
        "interval",
        "once",
        "manual"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "listId",
    "messageSource",
    "schedule"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255,
      "description": "Campaign name (default: 'Campaign')"
    },
    "botId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "description": "Bot to send through when sendMode='bot'; its channel is used"
    },
    "listId": {
      "type": "string",
      "format": "uuid",
      "description": "The contact list to run the campaign over"
    },
    "schedule": {
      "allOf": [
        {
          "anyOf": [
            {
              "type": "object",
              "required": [
                "kind",
                "everyMs"
              ],
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "interval"
                },
                "everyMs": {
                  "type": "integer",
                  "minimum": 60000,
                  "description": "Milliseconds between runs, e.g. 86400000 for daily"
                }
              },
              "additionalProperties": false
            },
            {
              "type": "object",
              "required": [
                "kind",
                "hour"
              ],
              "properties": {
                "hour": {
                  "type": "integer",
                  "maximum": 23,
                  "minimum": 0,
                  "description": "UTC hour"
                },
                "kind": {
                  "type": "string",
                  "const": "daily"
                },
                "minute": {
                  "type": "integer",
                  "maximum": 59,
                  "minimum": 0
                }
              },
              "additionalProperties": false
            },
            {
              "type": "object",
              "required": [
                "kind",
                "days",
                "hour"
              ],
              "properties": {
                "days": {
                  "type": "array",
                  "items": {
                    "type": "integer",
                    "maximum": 6,
                    "minimum": 0
                  },
                  "minItems": 1,
                  "description": "Days of week, 0=Sun … 6=Sat"
                },
                "hour": {
                  "type": "integer",
                  "maximum": 23,
                  "minimum": 0,
                  "description": "UTC hour"
                },
                "kind": {
                  "type": "string",
                  "const": "weekly"
                },
                "minute": {
                  "type": "integer",
                  "maximum": 59,
                  "minimum": 0
                }
              },
              "additionalProperties": false
            },
            {
              "type": "object",
              "required": [
                "kind",
                "dayOfMonth",
                "hour"
              ],
              "properties": {
                "hour": {
                  "type": "integer",
                  "maximum": 23,
                  "minimum": 0,
                  "description": "UTC hour"
                },
                "kind": {
                  "type": "string",
                  "const": "monthly"
                },
                "minute": {
                  "type": "integer",
                  "maximum": 59,
                  "minimum": 0
                },
                "dayOfMonth": {
                  "type": "integer",
                  "maximum": 31,
                  "minimum": 1
                }
              },
              "additionalProperties": false
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "endAt": {
              "type": "string",
              "description": "ISO date; the campaign completes after this"
            },
            "maxRuns": {
              "type": "integer",
              "minimum": 1,
              "description": "Stop after this many runs"
            },
            "timezone": {
              "type": "string",
              "description": "IANA timezone the daily/weekly/monthly time is interpreted in, e.g. 'Africa/Lagos'. Defaults to UTC. Ignored for 'interval'. The schedule holds its local wall-clock time across DST."
            }
          }
        }
      ],
      "description": "When each batch fires. e.g. daily at 9am in Africa/Lagos, or every weekend."
    },
    "sendMode": {
      "enum": [
        "message",
        "bot"
      ],
      "type": "string",
      "description": "'message' sends a plain broadcast; 'bot' initiates the conversation through a bot (default: 'message')"
    },
    "batchSize": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "How many contacts to message per run (default: 20)"
    },
    "channelId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "description": "WhatsApp channel to send from; falls back to the org default / first connected channel"
    },
    "onExhaust": {
      "enum": [
        "stop",
        "loop"
      ],
      "type": "string",
      "description": "When the whole list has been reached: 'stop' (default) completes the campaign; 'loop' starts a new cycle after loopCooldownMs"
    },
    "messageSource": {
      "anyOf": [
        {
          "type": "object",
          "required": [
            "kind",
            "text"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "const": "static"
            },
            "text": {
              "type": "string",
              "minLength": 1,
              "description": "The message body sent to each contact in the batch"
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "kind",
            "messages"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "const": "rotation"
            },
            "mode": {
              "enum": [
                "sequential",
                "random"
              ],
              "type": "string",
              "description": "Rotate in order (default) or pick randomly per run"
            },
            "messages": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1
              },
              "minItems": 1,
              "description": "Pool of messages"
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "kind",
            "ref"
          ],
          "properties": {
            "ref": {
              "type": "string",
              "minLength": 1,
              "description": "A Neuron Note ID; its content becomes the message, fetched live at each run"
            },
            "kind": {
              "type": "string",
              "const": "content"
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "kind",
            "prompt"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "const": "ai"
            },
            "botId": {
              "type": "string",
              "format": "uuid",
              "description": "Bot whose system prompt supplies business context"
            },
            "prompt": {
              "type": "string",
              "minLength": 1,
              "description": "Instruction for the message the AI should write"
            },
            "personaId": {
              "type": "string",
              "format": "uuid",
              "description": "Persona whose voice the message is written in"
            },
            "perContact": {
              "type": "boolean",
              "description": "Generate a distinct message per recipient (slower, more tokens). Default false = one message for the whole batch"
            }
          },
          "description": "AI-written message generated live at each run (BYOK-aware)",
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "kind",
            "url"
          ],
          "properties": {
            "url": {
              "type": "string",
              "format": "uri",
              "description": "POSTed { campaignId, listId, contact? }; returns { message } or a bare string"
            },
            "kind": {
              "type": "string",
              "const": "webhook"
            },
            "perContact": {
              "type": "boolean",
              "description": "Call once per recipient with the contact in the payload. Default false = one call per batch"
            }
          },
          "description": "Message fetched from your webhook at each run",
          "additionalProperties": false
        }
      ],
      "description": "How the message is resolved live at each batch run: 'static' (fixed), 'rotation' (cycle through several), 'ai' (AI-written), 'webhook' (from your service), or 'content' (a saved Neuron Note)."
    },
    "loopCooldownMs": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0
        },
        {
          "type": "null"
        }
      ],
      "description": "Milliseconds to wait before looping (default: 24h)"
    },
    "startImmediately": {
      "type": "boolean",
      "description": "Fire the first batch right away (default: true). Set false to wait for the first scheduled slot"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "channelId",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name of the newsletter visible to subscribers"
    },
    "channelId": {
      "type": "string",
      "description": "Identifier (UUID) of the WhatsApp session channel to create the newsletter on"
    },
    "description": {
      "type": "string",
      "description": "Description of the newsletter's purpose and content"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "botId",
    "name",
    "url",
    "eventTypes"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "Destination URL that will receive webhook event payloads (HTTPS recommended)"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the outbound webhook"
    },
    "botId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot to create the outbound webhook for"
    },
    "eventTypes": {
      "type": "array",
      "items": {
        "enum": [
          "message.created",
          "message.assistant",
          "conversation.created",
          "conversation.escalated",
          "conversation.released",
          "conversation.closed",
          "bot.paused",
          "bot.resumed",
          "number.throttled",
          "number.resumed"
        ],
        "type": "string"
      },
      "description": "Array of event types that should trigger this webhook"
    },
    "filterPrompt": {
      "type": "string",
      "description": "Optional LLM prompt to selectively filter which events are forwarded (e.g., 'only forward escalations about billing')"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "title",
    "priceMinor",
    "deliveryType"
  ],
  "properties": {
    "kind": {
      "type": [
        "string",
        "null"
      ],
      "description": "Short label e.g. 'E-book', 'Presets', 'Service'"
    },
    "codes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "For codeMode 'pool': the unique codes/keys to add (one gets sent per buyer). Appended to any existing pool."
    },
    "theme": {
      "type": "object",
      "description": "Per-product theme: { bg, accent, text (hex), mode: 'light'|'dark', layout: 'hero'|'side', coverAspect: '16/10'|'3/2'|'1/1'|'4/5', cta: buy-button label e.g. 'Reserve your hour' }",
      "additionalProperties": {
        "type": "string"
      }
    },
    "title": {
      "type": "string",
      "description": "Product title shown to buyers"
    },
    "content": {
      "type": "array",
      "description": "Rich product-page content blocks. Ordered array of {type, ...}: heading {text,level}, text {markdown}, image {url,caption}, video {url}, callout {emoji,text}, collapsible {title,blocks[]}, divider {}, button {label,url}, embed {url}, spacer {}"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the product is live"
    },
    "category": {
      "type": [
        "string",
        "null"
      ],
      "description": "Category label e.g. 'Productivity'"
    },
    "codeMode": {
      "enum": [
        "shared",
        "pool",
        "generated"
      ],
      "type": "string",
      "description": "For deliveryType 'code': 'shared' (same text to every buyer), 'pool' (a unique code per sale from codes you upload — sells out when empty), or 'generated' (auto-mint a unique license key per sale)"
    },
    "currency": {
      "type": "string",
      "description": "ISO currency (default NGN)"
    },
    "feePayer": {
      "enum": [
        "buyer",
        "seller"
      ],
      "type": "string",
      "description": "'buyer' (fee added on top, seller gets full price — default) or 'seller' (fee deducted)"
    },
    "channelId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "description": "WhatsApp session UUID used to deliver the product (defaults to the org default channel)"
    },
    "coverType": {
      "enum": [
        "none",
        "emoji",
        "image",
        "color",
        "gradient"
      ],
      "type": "string",
      "description": "How the cover renders"
    },
    "emailBody": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "type": "null"
        }
      ],
      "description": "Custom message for the buyer's delivery email: plain text (no HTML), blank line = new paragraph, **bold**, links auto-linked, same variables as emailSubject. The download button / link / code is always added below it automatically. Null = the default message."
    },
    "coverColor": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cover colour (hex) for 'color'/'gradient' cover types"
    },
    "coverEmoji": {
      "type": [
        "string",
        "null"
      ],
      "description": "Emoji used as a cover fallback (e.g. 📓)"
    },
    "membership": {
      "type": "boolean",
      "description": "Make this a recurring subscription/membership: it tracks a paid period per buyer, renews from their Neuron wallet when possible (else emails a reminder — no card auto-charge), and marks them lapsed when the period + grace passes. React to membership.started/renewed/lapsed in Flows to deliver whatever the membership grants."
    },
    "priceMinor": {
      "type": "integer",
      "description": "Current price (charged). Amount in kobo (minor units): ₦1 = 100. Minimum ₦500 = 50000. Set 0 for a free product (no payment)."
    },
    "coverColor2": {
      "type": [
        "string",
        "null"
      ],
      "description": "Second colour (hex) for 'gradient' cover"
    },
    "description": {
      "type": "string",
      "description": "Rich description / what the buyer gets"
    },
    "deliveryText": {
      "type": [
        "string",
        "null"
      ],
      "description": "For 'link'/'code': the link or code the buyer receives. Optional note for 'file'."
    },
    "deliveryType": {
      "enum": [
        "file",
        "link",
        "code"
      ],
      "type": "string",
      "description": "How the product is delivered: 'file' (uploaded file), 'link' (URL), or 'code' (text/code)"
    },
    "emailSubject": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 200
        },
        {
          "type": "null"
        }
      ],
      "description": "Custom subject for the buyer's delivery email. Variables: {{buyer_first_name}}, {{buyer_name}}, {{product_title}}, {{store_name}}, {{access_link}}, {{code}}, {{order_ref}}. Null = default ('Your {{product_title}} is ready')."
    },
    "coverImageUrl": {
      "anyOf": [
        {
          "type": "string",
          "format": "uri"
        },
        {
          "type": "null"
        }
      ],
      "description": "Cover image URL"
    },
    "checkoutFields": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "key",
          "label",
          "type"
        ],
        "properties": {
          "key": {
            "type": "string"
          },
          "type": {
            "enum": [
              "text",
              "textarea",
              "number",
              "email",
              "phone",
              "select"
            ],
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "required": {
            "type": "boolean"
          },
          "placeholder": {
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "description": "Custom checkout questions the buyer answers (name, address, specs/customisations…). Their answers are attached to the order and sent to the seller."
    },
    "deliveryChannel": {
      "enum": [
        "email",
        "both"
      ],
      "type": "string",
      "description": "How buyers receive it. 'email' (default for new products): a branded email from your store only, with no WhatsApp needed and no ban risk on big launches. 'both': also sends from your connected WhatsApp, within the number's daily new-contact cap (buyers past the cap still get the email)."
    },
    "deliveryFileUrl": {
      "anyOf": [
        {
          "type": "string",
          "format": "uri"
        },
        {
          "type": "null"
        }
      ],
      "description": "For deliveryType 'file': the uploaded file URL (upload first with neuron_upload_media)"
    },
    "deliveryFileName": {
      "type": [
        "string",
        "null"
      ],
      "description": "Filename shown on the download button and in the WhatsApp document"
    },
    "membershipInterval": {
      "anyOf": [
        {
          "enum": [
            "daily",
            "weekly",
            "monthly"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Billing period. Required when membership is true."
    },
    "originalPriceMinor": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional compare-at / 'was' price (kobo), shown struck through. Must be ≥ current price."
    },
    "membershipGraceDays": {
      "type": "integer",
      "minimum": 0,
      "description": "Days after the period ends before an unpaid member lapses (and, if a group is attached, is removed from it). Default 1."
    },
    "membershipGroupName": {
      "type": [
        "string",
        "null"
      ],
      "description": "Group subject used when the attached group is auto-created (defaults to the product title). Only relevant with membershipGroupSlug."
    },
    "membershipGroupSlug": {
      "type": [
        "string",
        "null"
      ],
      "description": "OPTIONAL: attach a WhatsApp group as a membership perk. Org-unique handle (lowercase letters, numbers, hyphens); the group is created on the first sale, buyers are added on renewal and removed on lapse. Your connected number must be a group admin. Omit for a membership that isn't group-based."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "title",
    "message",
    "sourceType"
  ],
  "properties": {
    "type": {
      "enum": [
        "blast",
        "drip"
      ],
      "type": "string",
      "description": "'blast' sends to everyone at once (default); 'drip' sends in scheduled batches"
    },
    "title": {
      "type": "string",
      "description": "Internal campaign title"
    },
    "budget": {
      "type": "number",
      "description": "Budget in kobo (required for sourceType 'platform'; caps how many messages send)"
    },
    "phones": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Raw phone numbers to text (required when sourceType is 'phones'); normalized + de-duplicated server-side, invalid ones dropped"
    },
    "message": {
      "type": "string",
      "description": "The SMS text to send. Include an opt-out (e.g. 'Reply STOP')."
    },
    "sourceType": {
      "enum": [
        "all_contacts",
        "contact_list",
        "phones",
        "platform",
        "curated"
      ],
      "type": "string",
      "description": "Audience source"
    },
    "countryCodes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Restrict to these country calling codes (e.g. ['234']). Omit for all."
    },
    "poolEntryIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "SMS-enabled list-pool entry UUIDs (required when sourceType is 'curated'; find them with neuron_browse_list_pool { smsEnabled: true })"
    },
    "smsChannelId": {
      "type": "string",
      "description": "BYOK SMS channel UUID to send through instead of the platform provider"
    },
    "sourceListIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Contact list UUIDs (required when sourceType is 'contact_list')"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "platform",
    "label"
  ],
  "properties": {
    "label": {
      "type": "string",
      "description": "Display name for the channel (e.g., 'Brand IG Account')"
    },
    "platform": {
      "enum": [
        "instagram",
        "twitter"
      ],
      "type": "string",
      "description": "Social media platform: 'instagram' or 'twitter'"
    },
    "username": {
      "type": "string",
      "description": "Social media username (without @)"
    },
    "credentials": {
      "type": "string",
      "description": "Session credentials as JSON string with account, session.cookies, session.headers, etc."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "botId",
    "title",
    "instruction",
    "scheduleKind"
  ],
  "properties": {
    "botId": {
      "type": "string",
      "description": "UUID of the bot"
    },
    "title": {
      "type": "string",
      "description": "Short title for the task"
    },
    "config": {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "description": "Simulate the run without actually sending messages."
        },
        "channelId": {
          "type": "string",
          "description": "WhatsApp channel UUID to act on (defaults to the bot's primary)."
        },
        "maxActions": {
          "type": "integer",
          "description": "Hard cap on outbound actions per run (default 25)."
        },
        "noRepeatDays": {
          "type": "integer",
          "description": "Never re-message the same contact within this many days (default 14)."
        },
        "approvalPhone": {
          "type": "string",
          "description": "Admin phone (international format) to send the approval prompt to."
        },
        "requiresApproval": {
          "type": "boolean",
          "description": "Ask an admin on WhatsApp to approve before the task sends."
        }
      },
      "description": "Safety / execution config for the task.",
      "additionalProperties": false
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the task is active (default true)."
    },
    "schedule": {
      "type": "object",
      "description": "Schedule payload matching scheduleKind. cron: { time: 'HH:MM', days?: number[] } (0=Sunday..6=Saturday; empty/omitted = every day). interval: { everyMinutes: number }. once: { runAt: ISO8601 string }. manual: {}.",
      "additionalProperties": {}
    },
    "timezone": {
      "type": "string",
      "description": "IANA timezone (e.g. Africa/Lagos). Defaults to UTC."
    },
    "instruction": {
      "type": "string",
      "description": "What the task should do, in natural language (self-contained; preserve any exact message copy verbatim)."
    },
    "scheduleKind": {
      "enum": [
        "cron",
        "interval",
        "once",
        "manual"
      ],
      "type": "string",
      "description": "cron = recurring at a clock time (slot); interval = every N minutes; once = a single future moment; manual = only runs on demand."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "botId",
    "name",
    "description",
    "type",
    "config"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Human-readable name for the tool"
    },
    "type": {
      "enum": [
        "http_api",
        "webhook",
        "mcp"
      ],
      "type": "string",
      "description": "Type of the tool integration"
    },
    "botId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot to create the tool for"
    },
    "config": {
      "type": "object",
      "properties": {
        "method": {
          "enum": [
            "GET",
            "POST",
            "PUT",
            "PATCH",
            "DELETE"
          ],
          "type": "string",
          "description": "HTTP method to use"
        },
        "headers": {
          "type": "object",
          "description": "HTTP headers to include with each request as key-value pairs",
          "additionalProperties": {
            "type": "string"
          }
        },
        "endpoint": {
          "type": "string",
          "description": "Target HTTP endpoint URL for http_api tools"
        },
        "webhookUrl": {
          "type": "string",
          "description": "Webhook URL for webhook-type tools"
        },
        "asyncConfig": {
          "type": "object",
          "properties": {
            "jobIdPath": {
              "type": "string",
              "description": "Dot-notation path to extract job ID from initial response (e.g. 'id', 'request_id')"
            },
            "resultPath": {
              "type": "string",
              "description": "Dot-notation path to extract final result from completed response (e.g. 'output')"
            },
            "statusPath": {
              "type": "string",
              "description": "Dot-notation path to status field in poll response (e.g. 'status')"
            },
            "maxPollingMs": {
              "type": "number",
              "maximum": 300000,
              "minimum": 5000,
              "description": "Maximum time to poll before timeout (default: 120000)"
            },
            "failedStatuses": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Status values indicating failure (e.g. ['FAILED', 'failed', 'canceled'])"
            },
            "pollingEndpoint": {
              "type": "string",
              "description": "URL template with {{jobId}} placeholder for polling job status"
            },
            "completedStatuses": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Status values indicating completion (e.g. ['COMPLETED', 'succeeded'])"
            },
            "pollingIntervalMs": {
              "type": "number",
              "maximum": 30000,
              "minimum": 500,
              "description": "Milliseconds between poll requests (default: 2000)"
            }
          },
          "description": "Configuration for async submit-poll-download APIs like fal.ai and Replicate",
          "additionalProperties": false
        },
        "bodyTemplate": {
          "type": "string",
          "description": "Handlebars template for the request body, populated with conversation context"
        },
        "mcpServerUrl": {
          "type": "string",
          "description": "MCP server URL for mcp-type tools"
        },
        "parametersSchema": {
          "type": "object",
          "description": "JSON Schema describing the parameters the tool accepts",
          "additionalProperties": {}
        }
      },
      "description": "Tool configuration specifying the endpoint and request details",
      "additionalProperties": false
    },
    "authType": {
      "enum": [
        "none",
        "api_key",
        "bearer",
        "basic",
        "oauth2"
      ],
      "type": "string",
      "description": "Authentication type for the endpoint"
    },
    "rateLimit": {
      "type": "number",
      "description": "Maximum number of requests per minute allowed for this tool"
    },
    "timeoutMs": {
      "type": "number",
      "description": "Request timeout in milliseconds (default: 30000)"
    },
    "description": {
      "type": "string",
      "maxLength": 1000,
      "minLength": 1,
      "description": "Description of what the tool does and when the bot should use it"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "botId",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Human-readable name for the webhook"
    },
    "slug": {
      "type": "string",
      "description": "URL-friendly slug for the webhook endpoint (auto-generated if omitted)"
    },
    "botId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot to create the webhook for"
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether the webhook is active and accepting requests (default: true)"
    },
    "eventType": {
      "type": "string",
      "description": "Type of event this webhook handles (e.g., 'order.created', 'payment.received')"
    },
    "processingPrompt": {
      "type": "string",
      "description": "Prompt instructions to guide bot processing of incoming webhook data"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "adRequestId"
  ],
  "properties": {
    "adRequestId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the draft ad request to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the blog post to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the broadcast to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Calendar UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the draft campaign to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the channel to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the contact to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "idOrSlug"
  ],
  "properties": {
    "idOrSlug": {
      "type": "string",
      "description": "Unique identifier (UUID) or URL-friendly slug of the contact list to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Event (booking) UUID"
    },
    "scope": {
      "enum": [
        "single",
        "future",
        "all"
      ],
      "type": "string",
      "description": "Delete scope for recurring events (default: 'single')"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Event type UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the flow to delete."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "runId"
  ],
  "properties": {
    "runId": {
      "type": "string",
      "description": "UUID of the run to delete."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "kbId",
    "entryId"
  ],
  "properties": {
    "kbId": {
      "type": "string",
      "description": "Unique identifier of the knowledge base"
    },
    "entryId": {
      "type": "string",
      "description": "Unique identifier of the entry to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the knowledge base to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Campaign ID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "msgId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the conversation"
    },
    "msgId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the message to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the newsletter to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the outbound webhook to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "overrideId"
  ],
  "properties": {
    "overrideId": {
      "type": "string",
      "description": "Override UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Persona UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Product UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "campaignId"
  ],
  "properties": {
    "campaignId": {
      "type": "string",
      "description": "UUID of the draft SMS campaign to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the social channel to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the task"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the tool to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the webhook to delete"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Order UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "kbId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot"
    },
    "kbId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the knowledge base to detach"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "exportId": {
      "type": "string",
      "description": "An export started earlier; returns its download link when ready."
    },
    "dueForRemoval": {
      "type": "boolean",
      "description": "Only media that retention removes within the next 7 days."
    },
    "conversationIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Only these conversations."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "botId",
    "prompt"
  ],
  "properties": {
    "botId": {
      "type": "string",
      "description": "UUID of the bot"
    },
    "prompt": {
      "type": "string",
      "description": "Plain-English description of the task, e.g. 'every morning at 8am, message 10 people we haven't heard from in 10+ days with our intro offer'."
    },
    "timezone": {
      "type": "string",
      "description": "IANA timezone to assume (e.g. Africa/Lagos)."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Product UUID to clone"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "msgId",
    "content"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the conversation"
    },
    "msgId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the message to edit"
    },
    "content": {
      "type": "string",
      "description": "New text content to replace the existing message"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Product UUID (must be a membership product)"
    },
    "silent": {
      "type": "boolean",
      "description": "Suppress the membership.started event so welcome/onboarding flows don't fire — recommended for a bulk backfill of people who are already in."
    },
    "members": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "phone"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Display name (optional)"
          },
          "phone": {
            "type": "string",
            "description": "Phone number (any format; non-digits stripped)"
          }
        },
        "additionalProperties": false
      },
      "description": "People to enroll. Omit when using fromGroup."
    },
    "fromGroup": {
      "type": "boolean",
      "description": "Pull every current participant of the product's attached group and enroll them all."
    },
    "addToGroup": {
      "type": "boolean",
      "description": "Also add each phone to the attached WhatsApp group (for people not yet in it). Default false = assume they're already in."
    },
    "firstPeriodDays": {
      "type": "integer",
      "maximum": 3650,
      "minimum": 0,
      "description": "Free days before their first renewal. Omit to grant one normal interval (daily/weekly/monthly)."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "campaignId"
  ],
  "properties": {
    "campaignId": {
      "type": "string",
      "description": "UUID of the draft SMS campaign"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the flow."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "type",
    "config"
  ],
  "properties": {
    "type": {
      "enum": [
        "csv",
        "text_paste",
        "document",
        "web_scrape",
        "tool_output",
        "instagram",
        "x",
        "facebook",
        "tiktok",
        "stream"
      ],
      "type": "string",
      "description": "Lead source type. facebook = Meta Ads Library advertisers; web/IG/X/FB scraping needs DeepAPI configured; TikTok has no native provider (use tool_output)."
    },
    "config": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "contactId"
  ],
  "properties": {
    "contactId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the contact to look up"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "channelId",
    "messageId",
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "Destination chat JID"
    },
    "from": {
      "type": "string",
      "description": "Source chat JID"
    },
    "channelId": {
      "type": "string",
      "description": "WhatsApp channel identifier (UUID)"
    },
    "messageId": {
      "type": "string",
      "description": "WhatsApp message ID to forward"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "adRequestId"
  ],
  "properties": {
    "adRequestId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the approved ad request to fund"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the approved campaign to fund"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "amount",
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address to receive the payment receipt"
    },
    "amount": {
      "type": "integer",
      "description": "Amount to fund in the smallest currency unit — kobo for NGN (e.g., 500000 = NGN 5,000)",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Persona UUID"
    },
    "count": {
      "type": "integer",
      "maximum": 10,
      "minimum": 1,
      "description": "Number of variations (1-10, default 1)."
    },
    "topic": {
      "type": "string",
      "description": "What to write about."
    },
    "format": {
      "type": "string",
      "description": "Desired format (post, reply, caption, thread, DM...)."
    },
    "platform": {
      "type": "string",
      "description": "Target platform (instagram/x/tiktok/linkedin/facebook/whatsapp...)."
    },
    "extraInstructions": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "adRequestId"
  ],
  "properties": {
    "adRequestId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the ad request"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "adRequestId"
  ],
  "properties": {
    "adRequestId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the ad request to get analytics for"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "apiKey",
    "approvalId"
  ],
  "properties": {
    "apiKey": {
      "type": "string",
      "description": "Bot API key with 'nrn_' prefix for authentication"
    },
    "approvalId": {
      "type": "string",
      "description": "The approval request id (UUID)"
    },
    "waitSeconds": {
      "type": "integer",
      "maximum": 60,
      "minimum": 1,
      "description": "Long-poll up to N seconds for resolution"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "calendarId"
  ],
  "properties": {
    "calendarId": {
      "type": "string",
      "description": "Calendar UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "eventTypeId",
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "description": "End date (YYYY-MM-DD)"
    },
    "from": {
      "type": "string",
      "description": "Start date (YYYY-MM-DD)"
    },
    "timezone": {
      "type": "string",
      "description": "Invitee timezone for display"
    },
    "eventTypeId": {
      "type": "string",
      "description": "Event type UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "channelId"
  ],
  "properties": {
    "channelId": {
      "type": "string",
      "description": "WhatsApp channel identifier (UUID)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "slug"
  ],
  "properties": {
    "slug": {
      "type": "string",
      "description": "URL-friendly slug of the blog post (e.g., 'my-first-post')"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Booking UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot to retrieve analytics for"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the broadcast to retrieve"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the broadcast"
    },
    "page": {
      "type": "integer",
      "description": "Page number for pagination (default: 1)",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "description": "Number of recipients per page (default: 20)",
      "exclusiveMinimum": 0
    },
    "status": {
      "type": "string",
      "description": "Filter recipients by delivery status (e.g., 'delivered', 'failed', 'pending')"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "channelId",
    "jid"
  ],
  "properties": {
    "jid": {
      "type": "string",
      "description": "Contact JID or phone number to look up (e.g. '2348012345678' or '[email protected]')"
    },
    "channelId": {
      "type": "string",
      "description": "WhatsApp channel identifier (UUID)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Calendar UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the campaign"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the channel"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the channel"
    },
    "page": {
      "type": "integer",
      "description": "Page number for pagination (starts at 1)",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "description": "Number of events to return per page",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the Baileys channel"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the channel"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "collectionId"
  ],
  "properties": {
    "collectionId": {
      "type": "string",
      "description": "The collection id."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "collectionId"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "sort": {
      "enum": [
        "top",
        "recent"
      ],
      "type": "string",
      "description": "top = highest engagement first (default recent)."
    },
    "type": {
      "type": "string",
      "description": "Filter by item type (post|comment|profile|page|custom)."
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "minimum": 1
    },
    "collectionId": {
      "type": "string",
      "description": "The collection id."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the contact"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "idOrSlug"
  ],
  "properties": {
    "idOrSlug": {
      "type": "string",
      "description": "Unique identifier (UUID) or URL-friendly slug of the contact list"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "idOrSlug"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "description": "Page number for pagination (default: 1)",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "description": "Number of items per page (default: 20)",
      "exclusiveMinimum": 0
    },
    "search": {
      "type": "string",
      "description": "Search term to filter members by name or phone number"
    },
    "idOrSlug": {
      "type": "string",
      "description": "Unique identifier (UUID) or URL-friendly slug of the contact list"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the conversation"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the campaign to check eligibility for"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Event type UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the flow."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "revisionId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the flow."
    },
    "revisionId": {
      "type": "string",
      "description": "UUID of the revision (from neuron_list_flow_revisions)."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "runId"
  ],
  "properties": {
    "runId": {
      "type": "string",
      "description": "UUID of the run."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "channelId",
    "groupJid"
  ],
  "properties": {
    "groupJid": {
      "type": "string",
      "description": "Group JID (ending in @g.us)"
    },
    "channelId": {
      "type": "string",
      "description": "WhatsApp channel identifier (UUID)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "groupJid"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the channel"
    },
    "groupJid": {
      "type": "string",
      "description": "JID (Jabber ID) of the WhatsApp group (e.g., '[email protected]')"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the Instagram social channel"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "q": {
      "type": "string",
      "description": "Search username or name"
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "limit": {
      "type": "integer",
      "maximum": 200,
      "minimum": 1
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "kbId",
    "importId"
  ],
  "properties": {
    "kbId": {
      "type": "string",
      "description": "Knowledge base the import writes to"
    },
    "importId": {
      "type": "string",
      "description": "id returned by neuron_import_whatsapp_chat"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the knowledge base"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Campaign ID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the conversation"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of messages to return per page",
      "exclusiveMinimum": 0
    },
    "cursor": {
      "type": "string",
      "description": "Opaque pagination cursor from a previous response for retrieving the next page"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the newsletter to retrieve"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "orgId"
  ],
  "properties": {
    "orgId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the organization to retrieve"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the outbound webhook to get logs for"
    },
    "page": {
      "type": "number",
      "description": "Page number for pagination (default: 1)"
    },
    "limit": {
      "type": "number",
      "description": "Number of log entries per page (default: 20)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Persona UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the pool item to retrieve"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "channelId"
  ],
  "properties": {
    "channelId": {
      "type": "string",
      "description": "WhatsApp channel identifier (UUID)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Product UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the scheduled message"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "campaignId"
  ],
  "properties": {
    "campaignId": {
      "type": "string",
      "description": "UUID of the SMS campaign"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the social channel"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the social channel"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the task"
    },
    "page": {
      "type": "integer",
      "description": "Page number (default 1)",
      "exclusiveMinimum": 0
    },
    "limit": {
      "type": "integer",
      "description": "Items per page (default 20)",
      "exclusiveMinimum": 0
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the webhook to get logs for"
    },
    "page": {
      "type": "number",
      "description": "Page number for pagination (default: 1)"
    },
    "limit": {
      "type": "number",
      "description": "Number of log entries per page (default: 20)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "calendarId"
  ],
  "properties": {
    "calendarId": {
      "type": "string",
      "description": "Calendar UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "calendarId"
  ],
  "properties": {
    "calendarId": {
      "type": "string",
      "description": "Calendar UUID"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "channelId",
    "groupJid",
    "participants",
    "action"
  ],
  "properties": {
    "action": {
      "enum": [
        "approve",
        "reject"
      ],
      "type": "string",
      "description": "Whether to approve or reject the join requests"
    },
    "groupJid": {
      "type": "string",
      "description": "Group JID (ending in @g.us)"
    },
    "channelId": {
      "type": "string",
      "description": "WhatsApp channel identifier (UUID)"
    },
    "participants": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "description": "Array of phone numbers or JIDs of requesters"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "contacts"
  ],
  "properties": {
    "contacts": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "phone"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "Full name of the contact"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Tags to categorize the contact"
          },
          "email": {
            "type": "string",
            "description": "Email address of the contact"
          },
          "notes": {
            "type": "string",
            "description": "Additional notes about the contact"
          },
          "phone": {
            "type": "string",
            "description": "Contact phone number in E.164 format (e.g., +2348012345678)"
          }
        },
        "additionalProperties": false
      },
      "description": "Array of contact objects to import into the organization"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "file"
  ],
  "properties": {
    "file": {
      "type": "object",
      "description": "The exported flow file object.",
      "additionalProperties": {}
    },
    "name": {
      "type": "string",
      "description": "Name for the new flow. Defaults to the name in the file."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "kbId"
  ],
  "properties": {
    "kbId": {
      "type": "string",
      "description": "Knowledge base to fill"
    },
    "text": {
      "type": "string",
      "description": "The exported chat text (use this or filePath)"
    },
    "folder": {
      "type": "string",
      "description": "Folder for the entries (default 'listings')"
    },
    "filePath": {
      "type": "string",
      "description": "Path to the exported .txt on this machine (use this or text)"
    },
    "keepDays": {
      "type": "integer",
      "maximum": 90,
      "minimum": 1,
      "description": "How long a listing with no date stays valid after it was posted (default 14)"
    },
    "sinceDays": {
      "type": "integer",
      "maximum": 90,
      "minimum": 1,
      "description": "Only read messages from the last N days (default 30)"
    },
    "instructions": {
      "type": "string",
      "maxLength": 2000,
      "description": "What counts as a listing in this group, in plain words"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "knowledgeBaseId",
    "title",
    "content"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "Title for the knowledge entry"
    },
    "folder": {
      "type": "string",
      "description": "Folder: 'general', 'skills', 'contexts', 'documents', or 'faqs' (default: general)"
    },
    "source": {
      "enum": [
        "api",
        "mcp"
      ],
      "type": "string",
      "default": "mcp",
      "description": "Source type (default: mcp)"
    },
    "content": {
      "type": "string",
      "description": "Content to ingest"
    },
    "sourceUrl": {
      "type": "string",
      "description": "Source URL for reference"
    },
    "externalId": {
      "type": "string",
      "description": "Unique external ID for deduplication (e.g. file path, URL)"
    },
    "processing": {
      "type": "object",
      "properties": {
        "mode": {
          "enum": [
            "raw",
            "summarize",
            "extract_facts",
            "custom"
          ],
          "type": "string",
          "default": "raw",
          "description": "Processing mode"
        },
        "instruction": {
          "type": "string",
          "description": "Custom instruction (only used with 'custom' mode)"
        }
      },
      "description": "Optional LLM processing before storage",
      "additionalProperties": false
    },
    "knowledgeBaseId": {
      "type": "string",
      "description": "Knowledge base ID to ingest into"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "mode"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the pool item to install"
    },
    "mode": {
      "enum": [
        "fork",
        "subscribe"
      ],
      "type": "string",
      "description": "Installation mode: 'fork' creates an independent copy, 'subscribe' links to publisher updates"
    },
    "targetKbId": {
      "type": "string",
      "description": "UUID of the knowledge base to install into (for knowledge_base types)"
    },
    "targetBotId": {
      "type": "string",
      "description": "UUID of the bot to attach the installed resource to (for tool_template or knowledge_base types)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "orgId",
    "email",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Full name of the person being invited"
    },
    "role": {
      "type": "string",
      "description": "Role to assign to the member (e.g., 'admin', 'agent', 'viewer')"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address of the person to invite"
    },
    "orgId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the organization"
    },
    "canViewConversations": {
      "type": "boolean",
      "description": "Whether the invited member can view conversations (default: true)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "channelId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier (UUID) of the campaign to join"
    },
    "channelId": {
      "type": "string",
      "description": "Unique identifier (UUID) of your WhatsApp channel to send messages from"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {},
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "channelId",
    "groupJid"
  ],
  "properties": {
    "groupJid": {
      "type": "string",
      "description": "Group JID (ending in @g.us)"
    },
    "channelId": {
      "type": "string",
      "description": "WhatsApp channel identifier (UUID)"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "page": {
      "type": "number",
      "description": "Page number for pagination (default: 1)"
    },
    "limit": {
      "type": "number",
      "description": "Number of items per page (default: 20)"
    },
    "status": {
      "type": "string",
      "description": "Filter by request status: 'draft', 'pending_review', 'approved', 'active', 'paused', 'completed', or 'rejected'"
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "botId"
  ],
  "properties": {
    "botId": {
      "type": "string",
      "description": "Unique identifier (UUID) of the bot whose API keys to retrieve"
    }
  },
  "additionalProperties": false
}