Server definition
- Hash
- sha256:871da2e4462faf37120158afd4d07e8241637a0c81c0133306ba5fdf8c5a0140
- What it is
- What a remote MCP server returned when asked what it offers: 173 tools
The blob, as servednamed by its sha256
{
"instructions": null,
"tools": [
{
"description": "Add users to an existing bulk job.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"job_id": {
"description": "The bulk job ID",
"type": "string"
},
"users": {
"description": "Array of user objects to add",
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array"
}
},
"required": [
"job_id",
"users"
],
"type": "object"
},
"name": "add_bulk_users",
"outputSchema": null
},
{
"description": "Append subscribers to a list without removing existing subscribers.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"list_id": {
"description": "The list ID",
"type": "string"
},
"recipients": {
"description": "Recipients to set on the list",
"items": {
"additionalProperties": false,
"properties": {
"recipientId": {
"description": "Recipient ID",
"type": "string"
}
},
"required": [
"recipientId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"list_id",
"recipients"
],
"type": "object"
},
"name": "add_subscribers_to_list",
"outputSchema": null
},
{
"description": "Add a user to a tenant.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"profile": {
"additionalProperties": {},
"description": "Tenant-scoped profile overrides",
"type": "object"
},
"tenant_id": {
"description": "The tenant ID",
"type": "string"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"tenant_id"
],
"type": "object"
},
"name": "add_user_to_tenant",
"outputSchema": null
},
{
"description": "Archive a journey. Archived journeys cannot be invoked but existing runs continue to completion.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"journey_id": {
"description": "The journey template ID to archive",
"type": "string"
}
},
"required": [
"journey_id"
],
"type": "object"
},
"name": "archive_journey",
"outputSchema": null
},
{
"description": "Archive a journey-scoped notification template. Archived templates cannot be sent.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"journey_id": {
"description": "The journey template ID that owns this notification",
"type": "string"
},
"notification_id": {
"description": "The notification template ID",
"type": "string"
}
},
"required": [
"notification_id",
"journey_id"
],
"type": "object"
},
"name": "archive_journey_template",
"outputSchema": null
},
{
"description": "Archive a notification template by ID.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"notification_id": {
"description": "The notification template ID to archive",
"type": "string"
}
},
"required": [
"notification_id"
],
"type": "object"
},
"name": "archive_notification",
"outputSchema": null
},
{
"description": "Archive a preference section. The section must be empty: delete its topics first, otherwise the request fails with 409.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"section_id": {
"description": "Id of the preference section to archive",
"type": "string"
}
},
"required": [
"section_id"
],
"type": "object"
},
"name": "archive_preference_section",
"outputSchema": null
},
{
"description": "Archive a topic within a section.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"section_id": {
"description": "Id of the preference section",
"type": "string"
},
"topic_id": {
"description": "Id of the subscription preference topic to archive",
"type": "string"
}
},
"required": [
"section_id",
"topic_id"
],
"type": "object"
},
"name": "archive_preference_topic",
"outputSchema": null
},
{
"description": "Archive a preview device set. Runs that used it keep their own copy of its devices. The Courier Recommended set cannot be archived.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"device_set_id": {
"description": "The device set id (pvs_...)",
"type": "string"
}
},
"required": [
"device_set_id"
],
"type": "object"
},
"name": "archive_preview_device_set",
"outputSchema": null
},
{
"description": "Archive a send request and all its associated messages by request ID.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"request_id": {
"description": "The request ID (requestId returned from /send)",
"type": "string"
}
},
"required": [
"request_id"
],
"type": "object"
},
"name": "archive_request",
"outputSchema": null
},
{
"description": "Archive a routing strategy. The strategy must not have associated notification templates; unlink all templates before archiving.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"routing_strategy_id": {
"description": "The routing strategy ID to archive",
"type": "string"
}
},
"required": [
"routing_strategy_id"
],
"type": "object"
},
"name": "archive_routing_strategy",
"outputSchema": null
},
{
"description": "Add a user to multiple tenants at once. A custom profile can be supplied per tenant.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"tenants": {
"description": "Array of tenant associations",
"items": {
"additionalProperties": false,
"properties": {
"profile": {
"additionalProperties": {},
"description": "Tenant-scoped profile overrides",
"type": "object"
},
"tenant_id": {
"description": "Tenant ID",
"type": "string"
}
},
"required": [
"tenant_id"
],
"type": "object"
},
"type": "array"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"tenants"
],
"type": "object"
},
"name": "bulk_add_user_tenants",
"outputSchema": null
},
{
"description": "Add multiple push/device tokens for a user in one request. Overwrites matching existing tokens.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"tokens": {
"description": "Token records to upsert",
"items": {
"additionalProperties": false,
"properties": {
"device": {
"additionalProperties": false,
"description": "Device metadata",
"properties": {
"ad_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"device_id": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"model": {
"type": "string"
},
"platform": {
"type": "string"
}
},
"type": "object"
},
"expiry_date": {
"description": "Expiry as ISO string, false to disable, or omit for default",
"type": [
"string",
"boolean"
]
},
"properties": {},
"provider_key": {
"description": "Push provider",
"enum": [
"firebase-fcm",
"apn",
"expo",
"onesignal"
],
"type": "string"
},
"token": {
"description": "The token string",
"type": "string"
},
"tracking": {}
},
"required": [
"token",
"provider_key"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"tokens"
],
"type": "object"
},
"name": "bulk_add_user_tokens",
"outputSchema": null
},
{
"description": "Replace a user's complete set of preference overrides in one request. The topics in the body become the recipient's entire override set: listed topics are created or updated, and every existing override not included is reset to its topic default. An empty `topics` array clears all overrides. Validation-atomic (all-or-nothing).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"tenant_id": {
"description": "Scope the replacement to a specific tenant context",
"type": "string"
},
"topics": {
"description": "The complete set of topic overrides. An empty array resets every existing override.",
"items": {
"additionalProperties": false,
"properties": {
"custom_routing": {
"description": "Custom channel routing order (e.g. inbox, email)",
"items": {
"type": "string"
},
"type": "array"
},
"has_custom_routing": {
"description": "Whether custom channel routing is set",
"type": "boolean"
},
"status": {
"description": "Preference status",
"enum": [
"OPTED_IN",
"OPTED_OUT",
"REQUIRED"
],
"type": "string"
},
"topic_id": {
"description": "The subscription topic ID",
"type": "string"
}
},
"required": [
"topic_id",
"status"
],
"type": "object"
},
"type": "array"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"topics"
],
"type": "object"
},
"name": "bulk_replace_user_preferences",
"outputSchema": null
},
{
"description": "Replace all subscribers on a list with the given recipients.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"list_id": {
"description": "The list ID",
"type": "string"
},
"recipients": {
"description": "Recipients to set on the list",
"items": {
"additionalProperties": false,
"properties": {
"recipientId": {
"description": "Recipient ID",
"type": "string"
}
},
"required": [
"recipientId"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"list_id",
"recipients"
],
"type": "object"
},
"name": "bulk_subscribe_to_list",
"outputSchema": null
},
{
"description": "Additively create or update a user's preferences for one or more topics in a single request. Only the topics in the body are touched; existing overrides for other topics are left untouched. Partial-success: valid topics are written and returned in `items`, unapplicable ones collected in `errors`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"tenant_id": {
"description": "Scope the update to a specific tenant context",
"type": "string"
},
"topics": {
"description": "Topics to create or update",
"items": {
"additionalProperties": false,
"properties": {
"custom_routing": {
"description": "Custom channel routing order (e.g. inbox, email)",
"items": {
"type": "string"
},
"type": "array"
},
"has_custom_routing": {
"description": "Whether custom channel routing is set",
"type": "boolean"
},
"status": {
"description": "Preference status",
"enum": [
"OPTED_IN",
"OPTED_OUT",
"REQUIRED"
],
"type": "string"
},
"topic_id": {
"description": "The subscription topic ID",
"type": "string"
}
},
"required": [
"topic_id",
"status"
],
"type": "object"
},
"type": "array"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"topics"
],
"type": "object"
},
"name": "bulk_update_user_preferences",
"outputSchema": null
},
{
"description": "Cancel a running automation by its cancelation_token. This invokes a second ad-hoc automation with a single cancel step. The token must match the cancelation_token set when the original automation was started. Note: spelling is \"cancelation_token\" (single \"l\").",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cancelation_token": {
"description": "The cancelation_token that was set when the automation was originally invoked",
"type": "string"
}
},
"required": [
"cancelation_token"
],
"type": "object"
},
"name": "cancel_automation",
"outputSchema": null
},
{
"description": "Cancel a broadcast's scheduled send. The broadcast itself is kept.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"broadcast_id": {
"description": "The broadcast id",
"type": "string"
}
},
"required": [
"broadcast_id"
],
"type": "object"
},
"name": "cancel_broadcast_schedule",
"outputSchema": null
},
{
"description": "Cancel journey runs. Supply EXACTLY ONE of cancelation_token (cancels every run associated with the token) or run_id (cancels a single run). Cancelation is idempotent: a run that already finished or was already canceled is left unchanged.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cancelation_token": {
"description": "Cancels every run associated with this token. Mutually exclusive with run_id.",
"type": "string"
},
"run_id": {
"description": "Cancels a single run by id. Mutually exclusive with cancelation_token.",
"type": "string"
}
},
"type": "object"
},
"name": "cancel_journey",
"outputSchema": null
},
{
"description": "Cancel a message that is currently being delivered. Returns the message details with updated status.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"message_id": {
"description": "The message ID to cancel",
"type": "string"
}
},
"required": [
"message_id"
],
"type": "object"
},
"name": "cancel_message",
"outputSchema": null
},
{
"description": "Cancel a notification template submission.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"notification_id": {
"description": "The notification template ID",
"type": "string"
},
"submission_id": {
"description": "The submission ID to cancel",
"type": "string"
}
},
"required": [
"notification_id",
"submission_id"
],
"type": "object"
},
"name": "cancel_notification_submission",
"outputSchema": null
},
{
"description": "Get the Courier SDK installation guide for one platform: the install command, a quick-start code sample and the relevant doc links. This is the answer to \"how do I integrate Courier\" or \"how do I get started\". Client-side platforms need a JWT to authenticate; each guide says so and names the tool that issues one.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"platform": {
"description": "Which SDK to return the installation guide for.",
"enum": [
"nodejs",
"python",
"react",
"ios",
"android",
"flutter",
"react native"
],
"type": "string"
}
},
"required": [
"platform"
],
"type": "object"
},
"name": "courier_installation_guide",
"outputSchema": null
},
{
"description": "Create a new brand. The API requires settings — omitting it returns a 400. If you do not have specific brand colors, omit settings and a safe default will be used automatically (black primary, white secondary). Example: { name: \"Acme\", settings: { colors: { primary: \"#1a73e8\", secondary: \"#ffffff\" } } }.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"id": {
"description": "Optional brand ID; auto-generated if omitted",
"type": "string"
},
"name": {
"description": "Brand display name",
"type": "string"
},
"settings": {
"additionalProperties": false,
"description": "Brand appearance settings. If omitted, defaults to { colors: { primary: \"#000000\", secondary: \"#ffffff\" } }.",
"properties": {
"colors": {
"additionalProperties": false,
"description": "Brand colors",
"properties": {
"primary": {
"description": "Primary brand color (hex, e.g. \"#1a73e8\")",
"type": "string"
},
"secondary": {
"description": "Secondary brand color (hex, e.g. \"#ffffff\")",
"type": "string"
},
"tertiary": {
"description": "Tertiary brand color (hex)",
"type": "string"
}
},
"required": [
"primary",
"secondary"
],
"type": "object"
},
"email": {
"additionalProperties": {},
"description": "Email template settings (header, footer)",
"type": "object"
},
"inapp": {
"additionalProperties": {},
"description": "In-app notification settings",
"type": "object"
}
},
"type": "object"
},
"snippets": {
"additionalProperties": {},
"description": "Brand snippets",
"type": "object"
}
},
"required": [
"name"
],
"type": "object"
},
"name": "create_brand",
"outputSchema": null
},
{
"description": "Create a broadcast: a one-off message to a list or audience on a single channel. It starts as a draft with no content; add content with put_broadcast_content, then send_broadcast or schedule_broadcast.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"channel": {
"description": "The single delivery channel for this broadcast",
"enum": [
"email",
"sms",
"push",
"inbox",
"slack",
"msteams"
],
"type": "string"
},
"name": {
"description": "Human-readable name",
"type": "string"
}
},
"required": [
"name",
"channel"
],
"type": "object"
},
"name": "create_broadcast",
"outputSchema": null
},
{
"description": "Create a new bulk job for sending messages to multiple recipients. Workflow: create_bulk_job → add_bulk_users → run_bulk_job.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"message": {
"additionalProperties": {},
"description": "Bulk message definition with event/template and content",
"type": "object"
}
},
"required": [
"message"
],
"type": "object"
},
"name": "create_bulk_job",
"outputSchema": null
},
{
"description": "Create a new journey. Always created as a draft; making it live is a separate step this tool cannot perform. Send two nodes: the trigger, and an exit node last. Both are required — a create with no exit node is rejected, and the API reports that as \"exit node must be the last node in the journey\" even when no exit was sent at all. Send and delay nodes are added afterwards by replace_journey, once journey-scoped templates exist. Node ids are server-generated; do NOT include an id field. Example: { name: \"Welcome Journey\", nodes: [{ type: \"trigger\", trigger_type: \"api-invoke\" }, { type: \"exit\" }], enabled: true }. The result carries a \"verification\" object read back from the server after the write — check it every time. verified:true means what you asked for is what saved. verified:false names what did not: \"fieldMismatches\" for node fields that failed to land, \"nodeCountMismatch\" for a node dropped or added, and \"unknownTemplateReferences\" for a send node pointing at a template id this journey does not have — almost always a mistyped id, so re-copy it from the create_journey_template or get_journey response it came from. Fix the specific thing named and send the corrected document. Re-sending an identical call changes nothing, and every replace_journey overwrites the whole draft again. An \"errorKind\" of \"unauthorized\" means the write itself succeeded and only the read-back was refused: report that as unconfirmed, never as a failed write.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Whether the journey is active. Defaults to true.",
"type": "boolean"
},
"name": {
"description": "Journey display name",
"type": "string"
},
"nodes": {
"description": "The trigger node, then a terminal exit node — both required. Send and delay nodes are added later by replace_journey. Node ids are server-generated — do NOT include an id field. Example: [{ type: \"trigger\", trigger_type: \"api-invoke\" }, { type: \"exit\" }].",
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array"
},
"state": {
"description": "Must be \"DRAFT\". These tools cannot publish.",
"enum": [
"DRAFT"
],
"type": "string"
}
},
"required": [
"name",
"nodes"
],
"type": "object"
},
"name": "create_journey",
"outputSchema": null
},
{
"description": "Create a notification template scoped to a journey. Always created as a draft; making it live is a separate step this tool cannot perform. The template can then be referenced in journey send nodes. content.elements must be wrapped in a channel block — the API rejects bare elements. Example: { journey_id: \"j-abc\", channel: \"email\", notification: { name: \"Welcome Email\", tags: [], brand: null, subscription: null, content: { version: \"2022-01-01\", elements: [{ type: \"channel\", channel: \"email\", elements: [{ type: \"text\", content: \"Hello!\" }] }] } } }. The result carries a \"verification\" object confirming the new id is really present on the journey. verified:true means the id in this response is safe to reference from a send node. verified:false means it is not visible yet — re-read the journey before referencing it, and do not create a second template to work around it. An \"errorKind\" of \"unauthorized\" means the template was created and only the check was refused.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"channel": {
"description": "Channel for this template (e.g. \"email\", \"push\", \"sms\", \"inbox\")",
"type": "string"
},
"journey_id": {
"description": "The journey template ID. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"notification": {
"additionalProperties": false,
"description": "Notification template definition",
"properties": {
"brand": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Brand to apply, or null"
},
"content": {
"additionalProperties": false,
"properties": {
"elements": {
"description": "Elemental content nodes. Must be wrapped in a channel block — the API rejects bare elements. Example: [{ type: \"channel\", channel: \"email\", elements: [{ type: \"text\", content: \"Hello!\" }] }].",
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array"
},
"scope": {
"enum": [
"default",
"strict"
],
"type": "string"
},
"version": {
"const": "2022-01-01",
"type": "string"
}
},
"required": [
"version",
"elements"
],
"type": "object"
},
"name": {
"description": "Template display name",
"type": "string"
},
"subscription": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"topic_id": {
"type": "string"
}
},
"required": [
"topic_id"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Subscription topic, or null"
},
"tags": {
"description": "Tag list (use [] if none)",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"tags",
"brand",
"subscription",
"content"
],
"type": "object"
},
"provider_key": {
"description": "Specific provider key to target",
"type": "string"
},
"state": {
"description": "Must be \"DRAFT\". These tools cannot publish.",
"enum": [
"DRAFT"
],
"type": "string"
}
},
"required": [
"journey_id",
"channel",
"notification"
],
"type": "object"
},
"name": "create_journey_template",
"outputSchema": null
},
{
"description": "Create or update a list by list ID.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"list_id": {
"description": "The list ID",
"type": "string"
},
"name": {
"description": "Display name for the list",
"type": "string"
}
},
"required": [
"list_id",
"name"
],
"type": "object"
},
"name": "create_list",
"outputSchema": null
},
{
"description": "Create a V2 notification template. name is required. Content may be provided inline or set separately afterwards. A newly created template is a draft; making it live is a separate step this tool cannot perform. Link a routing strategy via notification.routing.strategy_id to control which channels are used. Example: { notification: { name: 'welcome-email', tags: [], brand: null, subscription: null, routing: { strategy_id: 'rs_01abc' }, content: { version: '2022-01-01', elements: [] } } }.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"notification": {
"additionalProperties": false,
"description": "Notification template payload",
"properties": {
"brand": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Brand to apply, or null for none. Required on every call — never omit this key, and never send {}."
},
"content": {
"additionalProperties": false,
"description": "Elemental content, required on every call. Example: { version: \"2022-01-01\", elements: [{ type: \"text\", content: \"Hello!\" }] }.",
"properties": {
"elements": {
"description": "Elemental content nodes",
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array"
},
"version": {
"description": "Content version identifier, e.g. \"2022-01-01\"",
"type": "string"
}
},
"required": [
"version",
"elements"
],
"type": "object"
},
"name": {
"description": "Template display name",
"type": "string"
},
"routing": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"strategy_id": {
"description": "From a get_routing_strategy or list_notifications/get_notification response for THIS template's own intended strategy — never an id borrowed from an unrelated template found while searching for one.",
"type": "string"
}
},
"required": [
"strategy_id"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Routing strategy reference, or null to use the workspace default. Required on every call — never omit this key, and never send {}: the API rejects both an absent routing key and an empty object; if you have no strategy id, send null explicitly."
},
"subscription": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"topic_id": {
"type": "string"
}
},
"required": [
"topic_id"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Subscription topic reference, or null for none. Required on every call — never omit this key, and never send {}."
},
"tags": {
"description": "Tag list (use [] if none)",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"tags",
"brand",
"subscription",
"routing",
"content"
],
"type": "object"
},
"state": {
"description": "Must be \"DRAFT\". These tools cannot publish.",
"enum": [
"DRAFT"
],
"type": "string"
}
},
"required": [
"notification"
],
"type": "object"
},
"name": "create_notification",
"outputSchema": null
},
{
"description": "Create a new user profile or merge supplied values into an existing profile (POST). Existing fields not included are preserved.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"profile": {
"additionalProperties": {},
"default": {},
"description": "Profile data to create or merge (e.g. { email: \"...\", phone_number: \"...\" })",
"type": "object"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id"
],
"type": "object"
},
"name": "create_or_merge_user",
"outputSchema": null
},
{
"description": "Create or replace a push/device token for a user.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"device": {
"additionalProperties": false,
"description": "Device metadata",
"properties": {
"ad_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"device_id": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"model": {
"type": "string"
},
"platform": {
"type": "string"
}
},
"type": "object"
},
"provider_key": {
"description": "Push provider",
"enum": [
"firebase-fcm",
"apn",
"expo",
"onesignal"
],
"type": "string"
},
"token": {
"description": "The token string",
"type": "string"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"token",
"provider_key"
],
"type": "object"
},
"name": "create_or_replace_user_push_token",
"outputSchema": null
},
{
"description": "Create or replace a tenant. Tenants represent organizations or groups that users belong to.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"brand_id": {
"description": "Brand ID to associate with this tenant",
"type": "string"
},
"default_preferences": {
"additionalProperties": false,
"description": "Default notification preferences applied to users in this tenant. Example: { \"items\": [{ \"id\": \"topic_abc\", \"status\": \"OPTED_IN\", \"type\": \"subscription_topic\" }] }",
"properties": {
"items": {
"description": "One entry per subscription topic",
"items": {
"additionalProperties": false,
"properties": {
"custom_routing": {
"description": "Channels this topic delivers on when has_custom_routing is true",
"items": {
"enum": [
"direct_message",
"email",
"push",
"sms",
"webhook",
"inbox"
],
"type": "string"
},
"type": "array"
},
"has_custom_routing": {
"description": "Whether custom_routing overrides the topic's default channels",
"type": "boolean"
},
"id": {
"description": "Subscription topic ID this default applies to",
"type": "string"
},
"status": {
"description": "Default status for the topic. \"REQUIRED\" prevents users from opting out",
"enum": [
"OPTED_IN",
"OPTED_OUT",
"REQUIRED"
],
"type": "string"
},
"type": {
"const": "subscription_topic",
"description": "Always \"subscription_topic\" when provided",
"type": "string"
}
},
"required": [
"id",
"status"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
},
"name": {
"description": "Display name for the tenant",
"type": "string"
},
"parent_tenant_id": {
"description": "Parent tenant ID for hierarchical tenants",
"type": "string"
},
"properties": {
"additionalProperties": {},
"description": "Custom properties for the tenant",
"type": "object"
},
"tenant_id": {
"description": "The tenant ID",
"type": "string"
},
"user_profile": {
"additionalProperties": {},
"description": "Default profile data for users in this tenant",
"type": "object"
}
},
"required": [
"tenant_id",
"name"
],
"type": "object"
},
"name": "create_or_update_tenant",
"outputSchema": null
},
{
"description": "Create a preference section in your workspace. The section id is generated and returned. Add topics afterwards with create_preference_topic.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"has_custom_routing": {
"description": "Whether the section defines custom routing for its topics",
"type": "boolean"
},
"name": {
"description": "Human-readable name for the section",
"type": "string"
},
"routing_options": {
"description": "Default channels for the section. Defaults to empty if omitted.",
"items": {
"enum": [
"direct_message",
"email",
"push",
"sms",
"webhook",
"inbox"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"name": "create_preference_section",
"outputSchema": null
},
{
"description": "Create a subscription preference topic inside a section. The topic id is generated and returned. Fails with 404 if the section does not exist.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"allowed_preferences": {
"description": "Preference controls a recipient may customize for this topic",
"items": {
"enum": [
"snooze",
"channel_preferences"
],
"type": "string"
},
"type": "array"
},
"default_status": {
"description": "Default subscription status applied when a recipient has not set their own",
"enum": [
"OPTED_OUT",
"OPTED_IN",
"REQUIRED"
],
"type": "string"
},
"digest": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"audience_id": {
"description": "Optional audience the digest is scoped to",
"type": "string"
},
"categories": {
"description": "Retention rules per category key. Defaults to a single `digest` category.",
"items": {
"additionalProperties": false,
"properties": {
"category_key": {
"description": "Key identifying the category within the digest",
"type": "string"
},
"limit": {
"description": "How many collected events reach the rendered digest. Defaults to 10.",
"type": "integer"
},
"retain": {
"description": "Which collected events survive the limit",
"enum": [
"FIRST",
"LAST",
"HIGHEST",
"LOWEST",
"NONE"
],
"type": "string"
},
"sort_key": {
"description": "Data key to rank events by. Required when retain is HIGHEST or LOWEST.",
"type": "string"
}
},
"required": [
"category_key"
],
"type": "object"
},
"type": "array"
},
"schedules": {
"description": "The cadences this digest delivers on. At least one is required.",
"items": {
"additionalProperties": false,
"properties": {
"day_of_month": {
"description": "Required when frequency is monthly",
"type": "integer"
},
"day_of_week": {
"description": "Required when frequency is weekly",
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"days_of_week": {
"description": "Required when frequency is custom_days",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"type": "array"
},
"disabled": {
"description": "Whether the schedule is disabled",
"type": "boolean"
},
"frequency": {
"description": "How often the digest delivers. `instant` delivers each event immediately.",
"enum": [
"instant",
"daily",
"weekdays",
"weekly",
"custom_days",
"monthly"
],
"type": "string"
},
"is_default": {
"description": "The schedule recipients are placed on when they have not chosen one",
"type": "boolean"
},
"schedule_id": {
"description": "Id of an existing schedule to update. Omit to create a new one.",
"type": "string"
},
"time": {
"description": "24-hour local delivery time, HH:MM. Required for every frequency except instant.",
"type": "string"
},
"timezone": {
"description": "IANA timezone for `time` and the day fields, e.g. America/New_York",
"type": "string"
}
},
"required": [
"frequency"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"template_id": {
"description": "The notification template that renders the digest",
"type": "string"
},
"trigger_empty": {
"description": "Deliver the digest even when nothing was collected",
"type": "boolean"
}
},
"required": [
"template_id",
"schedules"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Batch this topic's notifications into a scheduled digest. Omit to leave any existing digest untouched; pass null to turn it off."
},
"include_unsubscribe_header": {
"description": "Whether to include a list-unsubscribe header on emails for this topic",
"type": "boolean"
},
"name": {
"description": "Human-readable name for the preference topic",
"type": "string"
},
"routing_options": {
"description": "Default channels delivered for this topic. Defaults to empty if omitted.",
"items": {
"enum": [
"direct_message",
"email",
"push",
"sms",
"webhook",
"inbox"
],
"type": "string"
},
"type": "array"
},
"section_id": {
"description": "Id of the preference section to create the topic in",
"type": "string"
},
"topic_data": {
"additionalProperties": {},
"description": "Arbitrary metadata associated with the topic",
"type": "object"
}
},
"required": [
"section_id",
"name",
"default_status"
],
"type": "object"
},
"name": "create_preference_topic",
"outputSchema": null
},
{
"description": "Create a named, reusable set of preview devices.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"device_ids": {
"description": "Device ids (pvd_...) from list_preview_devices. An id the catalog does not list is rejected.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"name": {
"description": "Human-readable name for the set",
"minLength": 1,
"type": "string"
}
},
"required": [
"name",
"device_ids"
],
"type": "object"
},
"name": "create_preview_device_set",
"outputSchema": null
},
{
"description": "Render a template's email on real email clients and capture screenshots. Pass exactly one of device_set_id or device_ids. Each run is billed to the workspace's previews add-on. The run starts PENDING, so poll get_preview_run for the results.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"data": {
"additionalProperties": {},
"description": "Variables for the template, the same shape as the data a send would carry",
"type": "object"
},
"device_ids": {
"description": "Device ids (pvd_...) from list_preview_devices. An id the catalog does not list is rejected.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"device_set_id": {
"description": "A saved device set id (pvs_...). Use the Courier Recommended set from list_preview_device_sets for a sensible default.",
"type": "string"
},
"locale": {
"description": "Locale to render, e.g. \"en-US\"",
"type": "string"
},
"template_id": {
"description": "The notification template id (nt_...). It must be a Design Studio template with an email channel.",
"type": "string"
},
"template_version": {
"description": "Which version renders: omit for the latest draft, \"published\" for the live version, or a publish such as \"v002\".",
"type": "string"
}
},
"required": [
"template_id"
],
"type": "object"
},
"name": "create_preview_run",
"outputSchema": null
},
{
"description": "Create a new provider (integration) configuration. Once routing strategies or notification templates reference this config, credential or settings mistakes can affect live sends—confirm provider key and settings against list_provider_catalog before saving. The provider field must be a known Courier provider key.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"alias": {
"description": "Short alias for referencing this provider",
"type": "string"
},
"provider": {
"description": "Provider key from the catalog (e.g. sendgrid, twilio, firebase-fcm)",
"type": "string"
},
"settings": {
"additionalProperties": {},
"description": "Provider-specific settings (API keys, credentials, etc.)",
"type": "object"
},
"title": {
"description": "Display name for this provider configuration",
"type": "string"
}
},
"required": [
"provider"
],
"type": "object"
},
"name": "create_provider",
"outputSchema": null
},
{
"description": "Create a routing strategy defining how notifications are delivered across channels and providers.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"channels": {
"additionalProperties": {},
"description": "Per-channel delivery configuration",
"type": "object"
},
"description": {
"description": "Description of the routing strategy",
"type": "string"
},
"name": {
"description": "Human-readable name for the routing strategy",
"type": "string"
},
"providers": {
"additionalProperties": {},
"description": "Per-provider delivery configuration",
"type": "object"
},
"routing": {
"additionalProperties": false,
"description": "Routing tree defining channel selection method and order",
"properties": {
"channels": {
"description": "Ordered list of channel names",
"items": {
"type": "string"
},
"type": "array"
},
"method": {
"description": "Deliver to all channels or stop after first success",
"enum": [
"all",
"single"
],
"type": "string"
}
},
"required": [
"method",
"channels"
],
"type": "object"
},
"tags": {
"description": "Tags for categorization",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"routing"
],
"type": "object"
},
"name": "create_routing_strategy",
"outputSchema": null
},
{
"description": "Delete an audience by its ID.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"audience_id": {
"description": "The audience ID to delete",
"type": "string"
}
},
"required": [
"audience_id"
],
"type": "object"
},
"name": "delete_audience",
"outputSchema": null
},
{
"description": "Delete a brand by its ID.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"brand_id": {
"description": "The brand ID to delete",
"type": "string"
}
},
"required": [
"brand_id"
],
"type": "object"
},
"name": "delete_brand",
"outputSchema": null
},
{
"description": "Delete a broadcast.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"broadcast_id": {
"description": "The broadcast id",
"type": "string"
}
},
"required": [
"broadcast_id"
],
"type": "object"
},
"name": "delete_broadcast",
"outputSchema": null
},
{
"description": "Delete a list by its ID.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"list_id": {
"description": "The list ID",
"type": "string"
}
},
"required": [
"list_id"
],
"type": "object"
},
"name": "delete_list",
"outputSchema": null
},
{
"description": "Delete a user profile permanently.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"user_id": {
"description": "The user ID to delete",
"type": "string"
}
},
"required": [
"user_id"
],
"type": "object"
},
"name": "delete_profile",
"outputSchema": null
},
{
"description": "Delete a provider configuration. Returns 409 if the provider is still referenced by routing or notifications.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"provider_id": {
"description": "The provider configuration ID to delete",
"type": "string"
}
},
"required": [
"provider_id"
],
"type": "object"
},
"name": "delete_provider",
"outputSchema": null
},
{
"description": "Delete a tenant by its ID.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"tenant_id": {
"description": "The tenant ID to delete",
"type": "string"
}
},
"required": [
"tenant_id"
],
"type": "object"
},
"name": "delete_tenant",
"outputSchema": null
},
{
"description": "Remove default notification preference for a topic from a tenant.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"tenant_id": {
"description": "The tenant ID",
"type": "string"
},
"topic_id": {
"description": "The subscription topic ID",
"type": "string"
}
},
"required": [
"tenant_id",
"topic_id"
],
"type": "object"
},
"name": "delete_tenant_preference",
"outputSchema": null
},
{
"description": "Delete a tenant notification template. Returns 204 on success, 404 if the template does not exist for this tenant.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"template_id": {
"description": "The notification template ID to delete",
"type": "string"
},
"tenant_id": {
"description": "The tenant ID that owns the template",
"type": "string"
}
},
"required": [
"tenant_id",
"template_id"
],
"type": "object"
},
"name": "delete_tenant_template",
"outputSchema": null
},
{
"description": "Delete all list subscriptions for a user.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id"
],
"type": "object"
},
"name": "delete_user_list_subscriptions",
"outputSchema": null
},
{
"description": "Delete a user's preference for a specific subscription topic, reverting it to the topic's default status.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"topic_id": {
"description": "The subscription topic ID",
"type": "string"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"topic_id"
],
"type": "object"
},
"name": "delete_user_preference_topic",
"outputSchema": null
},
{
"description": "Delete a specific push token for a user.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"token": {
"description": "The token identifier to delete",
"type": "string"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"token"
],
"type": "object"
},
"name": "delete_user_token",
"outputSchema": null
},
{
"description": "Copy a broadcast into a new draft. The original is left unchanged.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"broadcast_id": {
"description": "The broadcast to copy",
"type": "string"
}
},
"required": [
"broadcast_id"
],
"type": "object"
},
"name": "duplicate_broadcast",
"outputSchema": null
},
{
"description": "Generate a JWT authentication token for a user. Used for client-side SDK auth (Inbox, Preferences, etc.).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"expires_in": {
"default": "1h",
"description": "Token expiry duration (e.g. \"1h\", \"2 days\")",
"type": "string"
},
"scopes": {
"default": [
"write:user-tokens",
"inbox:read:messages",
"inbox:write:events",
"read:preferences",
"write:preferences",
"read:brands"
],
"description": "Permission scopes for the token",
"items": {
"type": "string"
},
"type": "array"
},
"user_id": {
"description": "The user ID to scope the token to",
"type": "string"
}
},
"required": [
"user_id"
],
"type": "object"
},
"name": "generate_jwt_for_user",
"outputSchema": null
},
{
"description": "Get one audience by ID, including the filter that defines its membership. Read this to explain why someone is or is not in an audience — the filter is the rule, not a stored member list. Use list_audience_members for who currently matches.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"audience_id": {
"description": "The audience ID",
"type": "string"
}
},
"required": [
"audience_id"
],
"type": "object"
},
"name": "get_audience",
"outputSchema": null
},
{
"description": "Get a specific audit event by its ID.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"audit_event_id": {
"description": "The audit event ID",
"type": "string"
}
},
"required": [
"audit_event_id"
],
"type": "object"
},
"name": "get_audit_event",
"outputSchema": null
},
{
"description": "Get one brand by ID, including its colors, logo and styling settings. Read this to describe what a template referencing this brand will actually look like.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"brand_id": {
"description": "The brand ID",
"type": "string"
}
},
"required": [
"brand_id"
],
"type": "object"
},
"name": "get_brand",
"outputSchema": null
},
{
"description": "Get a broadcast by id, including its channel and send or schedule state.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"broadcast_id": {
"description": "The broadcast id",
"type": "string"
}
},
"required": [
"broadcast_id"
],
"type": "object"
},
"name": "get_broadcast",
"outputSchema": null
},
{
"description": "Get a broadcast's Elemental content.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"broadcast_id": {
"description": "The broadcast id",
"type": "string"
}
},
"required": [
"broadcast_id"
],
"type": "object"
},
"name": "get_broadcast_content",
"outputSchema": null
},
{
"description": "Get the status of a bulk job.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"job_id": {
"description": "The bulk job ID",
"type": "string"
}
},
"required": [
"job_id"
],
"type": "object"
},
"name": "get_bulk_job",
"outputSchema": null
},
{
"description": "Get a journey by ID. Pass version=draft to retrieve the working draft, or version=vN for a historical version. Defaults to published.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"journey_id": {
"description": "The journey template ID. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"version": {
"description": "Version to retrieve: \"draft\", \"published\" (default), or a version string like \"v001\"",
"type": "string"
}
},
"required": [
"journey_id"
],
"type": "object"
},
"name": "get_journey",
"outputSchema": null
},
{
"description": "Get one journey run by id: its journey, status, and timestamps.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"run_id": {
"description": "The journey run id",
"type": "string"
}
},
"required": [
"run_id"
],
"type": "object"
},
"name": "get_journey_run",
"outputSchema": null
},
{
"description": "Get a journey-scoped notification template by notification ID. Pass version=draft to retrieve the working draft (required before the template has been published). Defaults to published.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"journey_id": {
"description": "The journey template ID that owns this notification. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"notification_id": {
"description": "The notification template ID. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"version": {
"description": "Version to retrieve: \"draft\", \"published\" (default), or \"vN\"",
"type": "string"
}
},
"required": [
"notification_id",
"journey_id"
],
"type": "object"
},
"name": "get_journey_template",
"outputSchema": null
},
{
"description": "Fetch the elemental content of a journey-scoped notification template. Pass version=draft for the working draft, or vN for a historical version. Defaults to published.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"journey_id": {
"description": "The journey template ID that owns this notification. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"notification_id": {
"description": "The notification template ID. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"version": {
"description": "Version to retrieve: \"draft\", \"published\" (default), or a version string like \"v001\"",
"type": "string"
}
},
"required": [
"notification_id",
"journey_id"
],
"type": "object"
},
"name": "get_journey_template_content",
"outputSchema": null
},
{
"description": "Get one list by its ID, including its name and current state.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"list_id": {
"description": "The list ID",
"type": "string"
}
},
"required": [
"list_id"
],
"type": "object"
},
"name": "get_list",
"outputSchema": null
},
{
"description": "List the users subscribed to a list. Use this to confirm whether someone was actually on a list at all — a subscription here is the reason a list-addressed send reached them.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"list_id": {
"description": "The list ID",
"type": "string"
}
},
"required": [
"list_id"
],
"type": "object"
},
"name": "get_list_subscribers",
"outputSchema": null
},
{
"description": "Get the full details and status of a single message by its ID.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"message_id": {
"description": "The message ID to retrieve",
"type": "string"
}
},
"required": [
"message_id"
],
"type": "object"
},
"name": "get_message",
"outputSchema": null
},
{
"description": "Get the rendered content (HTML, text, subject) of a previously sent message.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"message_id": {
"description": "The message ID",
"type": "string"
}
},
"required": [
"message_id"
],
"type": "object"
},
"name": "get_message_content",
"outputSchema": null
},
{
"description": "Get the event history for a message, showing each step in the delivery pipeline (enqueued, sent, delivered, etc.).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"message_id": {
"description": "The message ID",
"type": "string"
},
"type": {
"description": "Filter by event type",
"type": "string"
}
},
"required": [
"message_id"
],
"type": "object"
},
"name": "get_message_history",
"outputSchema": null
},
{
"description": "Retrieve a notification template by ID. Optionally request draft, published, or a version such as v001.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"notification_id": {
"description": "The notification template ID. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"version": {
"description": "Version to retrieve: \"draft\", \"published\" (default — omit this to get it), or a version string like \"v001\"",
"type": "string"
}
},
"required": [
"notification_id"
],
"type": "object"
},
"name": "get_notification",
"outputSchema": null
},
{
"description": "Get the published content blocks of a notification template.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"notification_id": {
"description": "The notification template ID. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
}
},
"required": [
"notification_id"
],
"type": "object"
},
"name": "get_notification_content",
"outputSchema": null
},
{
"description": "Get the draft (unpublished) content blocks of a notification template.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"notification_id": {
"description": "The notification template ID. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
}
},
"required": [
"notification_id"
],
"type": "object"
},
"name": "get_notification_draft_content",
"outputSchema": null
},
{
"description": "Delivery funnel for ONE notification template over time: sent, delivered, opened, clicked,\nerrors and undeliverable, per provider and channel, in time buckets.\n\nChoosing the window — supply EITHER `lookback` OR `start` and `end` together, NEVER both.\nSupplying both is rejected. For a relative window like 'the last week', `lookback` alone is\nthe whole answer: do not also pin `start` and `end`. Default is the last 30 days by day.\nFine granularities cover shorter windows: HOUR spans at most 7 days and DAY at most 90. How\nfar back a workspace may look also depends on its plan; a request reaching further back is\nrefused with a payment error, which means the plan does not cover that window, NOT that there\nis no data. A coarser granularity can reach further back than a fine one.\n\nReading the numbers correctly:\n- The first four counters are NESTED, not separate groups. Every delivered message is also\n counted in sent, every opened one in delivered, every clicked one in opened. So\n sent >= delivered >= opened >= clicked always. Report rates (delivered/sent) or the counters\n themselves. Do NOT add them together — the total is meaningless. And sent minus delivered is\n NOT a failure count; it is only 'did not reach the delivered stage', for any reason.\n- errors and undeliverable are counted separately and OVERLAP the funnel: a message that failed\n on one provider and succeeded on a retry appears in both errors and sent. They are not a\n remainder and do not complete a total.\n- Every counter is a count of distinct MESSAGES, not of events. A message that errored three\n times counts once in errors.\n- A bucket's `data` array holds one entry per provider and channel. To get a bucket total, add\n up the entries in that array — that is the only sum that means anything here. Note that rows\n for Courier's own built-in email sender are excluded, so these entries can add up to less\n than the workspace's true volume.\n\nWhat the buckets mean:\n- A message is counted in the bucket it was ENQUEUED in, not when the event happened. An open\n today of a message sent last Tuesday is counted in last Tuesday's bucket. So a past bucket\n can still change: yesterday's `opened` may be higher when you ask again tomorrow.\n- Results are cached for up to an hour and the pipeline adds its own lag, so a message sent\n minutes ago is expected NOT to appear yet. Never tell a user a just-sent message is missing;\n say the data has not caught up.\n- Read the window off the response's `start` and `end`, not off what you asked for. The API\n widens the window to whole buckets and returns the boundaries it actually used.\n- Quiet buckets are returned with an empty `data` array, so the series has no gaps.\n- An unknown template id returns an all-empty series rather than an error, and messages sent\n without a template never appear here at all. An empty result is not proof a template is\n unused — check that the id is right before concluding anything from it.\n- Because of that, a NOT FOUND / 404 error is never about the template id. It means the\n metrics endpoint itself could not be reached, which is an infrastructure or configuration\n problem on Courier's side. Say that the metrics service is unreachable and that someone\n should be told; do NOT tell the user to check or correct their template id, which sends\n them to fix something that was never wrong.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"end": {
"description": "Window end, ISO 8601 with offset. Requires start. Must not be combined with lookback.",
"maxLength": 64,
"type": "string"
},
"granularity": {
"default": "DAY",
"description": "Bucket size. HOUR covers at most 7 days, DAY at most 90. Defaults to DAY.",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH"
],
"type": "string"
},
"lookback": {
"description": "Window length counted back from now, as an ISO 8601 duration (P30D, P12W, PT12H). Defaults to P30D. Must not be combined with start/end.",
"maxLength": 32,
"type": "string"
},
"notification_id": {
"description": "The notification template ID to report on (no commas or whitespace)",
"minLength": 1,
"type": "string"
},
"start": {
"description": "Inclusive window start, ISO 8601 with offset (2026-04-01T00:00:00Z). Requires end. Must not be combined with lookback.",
"maxLength": 64,
"type": "string"
}
},
"required": [
"notification_id"
],
"type": "object"
},
"name": "get_notification_metrics",
"outputSchema": null
},
{
"description": "Get one preference section by ID, including its topics. Use this when you already know which section you need; list_preference_sections returns every section with its topics in one call.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"section_id": {
"description": "Id of the preference section",
"type": "string"
}
},
"required": [
"section_id"
],
"type": "object"
},
"name": "get_preference_section",
"outputSchema": null
},
{
"description": "Get one subscription topic within a section, including its default opt-in state. Returns 404 if the section or topic does not exist, or if the topic belongs to a different section — so a 404 here can mean the pairing is wrong rather than the topic missing.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"section_id": {
"description": "Id of the preference section",
"type": "string"
},
"topic_id": {
"description": "Id of the subscription preference topic",
"type": "string"
}
},
"required": [
"section_id",
"topic_id"
],
"type": "object"
},
"name": "get_preference_topic",
"outputSchema": null
},
{
"description": "Get a preview device set by id.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"device_set_id": {
"description": "The device set id (pvs_...)",
"type": "string"
}
},
"required": [
"device_set_id"
],
"type": "object"
},
"name": "get_preview_device_set",
"outputSchema": null
},
{
"description": "Get a preview run with its per-device results and screenshot URLs. Poll until status is COMPLETED or FAILED. The URLs are short-lived and re-signed on every read, so fetch them rather than storing them.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"preview_run_id": {
"description": "The preview run id (pvr_...)",
"type": "string"
},
"template_id": {
"description": "The notification template id (nt_...) the run previewed",
"type": "string"
}
},
"required": [
"template_id",
"preview_run_id"
],
"type": "object"
},
"name": "get_preview_run",
"outputSchema": null
},
{
"description": "Fetch a single provider configuration by ID.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"provider_id": {
"description": "The provider configuration ID",
"type": "string"
}
},
"required": [
"provider_id"
],
"type": "object"
},
"name": "get_provider",
"outputSchema": null
},
{
"description": "Retrieve a routing strategy by ID. Returns the full entity including routing, channels, and providers.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"routing_strategy_id": {
"description": "The routing strategy ID (rs_ prefix)",
"type": "string"
}
},
"required": [
"routing_strategy_id"
],
"type": "object"
},
"name": "get_routing_strategy",
"outputSchema": null
},
{
"description": "Get a tenant by its ID.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"tenant_id": {
"description": "The tenant ID",
"type": "string"
}
},
"required": [
"tenant_id"
],
"type": "object"
},
"name": "get_tenant",
"outputSchema": null
},
{
"description": "Get a tenant notification template association by template ID.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"template_id": {
"description": "The template ID",
"type": "string"
},
"tenant_id": {
"description": "The tenant ID",
"type": "string"
}
},
"required": [
"tenant_id",
"template_id"
],
"type": "object"
},
"name": "get_tenant_template",
"outputSchema": null
},
{
"description": "Get a specific version of a tenant notification template (e.g. latest, published, or v1).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"template_id": {
"description": "The template ID",
"type": "string"
},
"tenant_id": {
"description": "The tenant ID",
"type": "string"
},
"version": {
"description": "Version identifier (latest, published, or v-prefixed)",
"type": "string"
}
},
"required": [
"tenant_id",
"template_id",
"version"
],
"type": "object"
},
"name": "get_tenant_template_version",
"outputSchema": null
},
{
"description": "Get a translation for a specific locale (e.g. \"en_US\", \"fr_FR\").",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"domain": {
"default": "default",
"description": "Translation domain (only \"default\" is supported currently)",
"type": "string"
},
"locale": {
"description": "Locale code (e.g. en_US, fr_FR)",
"type": "string"
}
},
"required": [
"locale"
],
"type": "object"
},
"name": "get_translation",
"outputSchema": null
},
{
"description": "List the lists one user is subscribed to. Use this when explaining why a user received something — a subscription here is the reason a list-addressed send reached them, and its absence rules that path out.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id"
],
"type": "object"
},
"name": "get_user_list_subscriptions",
"outputSchema": null
},
{
"description": "Get one user's choice for a single subscription topic — whether they opted in or out, and per channel. Use this when you already know which topic is in question; get_user_preferences returns all of them at once.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"tenant_id": {
"description": "Omit this for the user's workspace-level choice, which answers most questions. Only pass it when you need this topic as scoped to one specific tenant.",
"type": "string"
},
"topic_id": {
"description": "The subscription topic ID",
"type": "string"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"topic_id"
],
"type": "object"
},
"name": "get_user_preference_topic",
"outputSchema": null
},
{
"description": "Get a user's notification preferences (subscriptions, opt-outs, channel preferences).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"tenant_id": {
"description": "Omit this to get the user's workspace-level preferences — that answers most preference questions. Only pass it when you need the tenant-scoped overrides for one specific tenant instead.",
"type": "string"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id"
],
"type": "object"
},
"name": "get_user_preferences",
"outputSchema": null
},
{
"description": "Get a user profile by their ID. Returns profile data including email, phone, and custom properties.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"user_id": {
"description": "The user ID to look up",
"type": "string"
}
},
"required": [
"user_id"
],
"type": "object"
},
"name": "get_user_profile_by_id",
"outputSchema": null
},
{
"description": "Get a specific push/device token for a user.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"token": {
"description": "The token identifier",
"type": "string"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"token"
],
"type": "object"
},
"name": "get_user_push_token",
"outputSchema": null
},
{
"description": "Invoke an ad-hoc automation with inline steps. Valid step actions: send, send-list, delay, cancel, update-profile, invoke, fetch-data. To cancel a previously started automation, use the cancel_automation tool instead.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"automation": {
"additionalProperties": false,
"description": "The automation definition with typed steps",
"properties": {
"cancelation_token": {
"description": "Token for cancelling this automation later (single \"l\" spelling)",
"type": "string"
},
"steps": {
"description": "Ordered array of automation steps",
"items": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"action": {
"const": "send",
"type": "string"
},
"brand": {
"type": "string"
},
"data": {
"additionalProperties": {},
"type": "object"
},
"if": {
"description": "Condition expression",
"type": "string"
},
"profile": {
"additionalProperties": {},
"type": "object"
},
"recipient": {
"type": "string"
},
"template": {
"description": "Notification template ID or key",
"type": "string"
}
},
"required": [
"action"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"action": {
"const": "send-list",
"type": "string"
},
"brand": {
"type": "string"
},
"data": {
"additionalProperties": {},
"type": "object"
},
"if": {
"type": "string"
},
"list": {
"description": "List ID to send to",
"type": "string"
},
"template": {
"type": "string"
}
},
"required": [
"action",
"list"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"action": {
"const": "delay",
"type": "string"
},
"duration": {
"description": "ISO 8601 duration (e.g. \"PT1H\" for 1 hour)",
"type": "string"
},
"if": {
"type": "string"
},
"until": {
"description": "ISO 8601 timestamp to wait until",
"type": "string"
}
},
"required": [
"action"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"action": {
"const": "cancel",
"type": "string"
},
"cancelation_token": {
"description": "The token set when the original automation was invoked (single \"l\" spelling)",
"type": "string"
},
"if": {
"type": "string"
}
},
"required": [
"action",
"cancelation_token"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"action": {
"const": "update-profile",
"type": "string"
},
"if": {
"type": "string"
},
"merge": {
"enum": [
"none",
"overwrite",
"soft-merge",
"replace"
],
"type": "string"
},
"profile": {
"additionalProperties": {},
"type": "object"
},
"recipient_id": {
"type": "string"
}
},
"required": [
"action"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"action": {
"const": "invoke",
"type": "string"
},
"if": {
"type": "string"
},
"template": {
"description": "Automation template ID to invoke",
"type": "string"
}
},
"required": [
"action",
"template"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"action": {
"const": "fetch-data",
"type": "string"
},
"if": {
"type": "string"
},
"merge_strategy": {
"enum": [
"replace",
"overwrite",
"soft-merge"
],
"type": "string"
},
"webhook": {
"additionalProperties": false,
"description": "HTTP request configuration",
"properties": {
"body": {
"additionalProperties": {},
"type": "object"
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH"
],
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}
},
"required": [
"action",
"webhook"
],
"type": "object"
}
]
},
"type": "array"
}
},
"required": [
"steps"
],
"type": "object"
},
"brand": {
"type": "string"
},
"data": {
"additionalProperties": {},
"type": "object"
},
"profile": {
"additionalProperties": {},
"type": "object"
},
"recipient": {
"type": "string"
},
"template": {
"type": "string"
}
},
"required": [
"automation"
],
"type": "object"
},
"name": "invoke_ad_hoc_automation",
"outputSchema": null
},
{
"description": "Invoke an automation run from an existing automation template. template_id refers to an existing automation template in the workspace. Example: { template_id: \"auto-onboarding\", recipient: \"user-123\", data: { plan: \"pro\" } }.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"brand": {
"description": "Brand ID override",
"type": "string"
},
"data": {
"additionalProperties": {},
"description": "Data to pass to the automation",
"type": "object"
},
"profile": {
"additionalProperties": {},
"description": "Profile data for the recipient",
"type": "object"
},
"recipient": {
"description": "Recipient user ID",
"type": "string"
},
"template": {
"description": "Notification template override",
"type": "string"
},
"template_id": {
"description": "The automation template ID",
"type": "string"
}
},
"required": [
"template_id",
"recipient"
],
"type": "object"
},
"name": "invoke_automation_template",
"outputSchema": null
},
{
"description": "Invoke a journey run from a journey template. template_id refers to an existing journey template in the workspace. Example: { template_id: \"j-onboarding\", user_id: \"user-123\", data: { plan: \"pro\" } }.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"data": {
"additionalProperties": {},
"description": "Data payload passed to the journey for conditions and template variables",
"type": "object"
},
"profile": {
"additionalProperties": {},
"description": "Profile data for the user (email, phone, custom fields)",
"type": "object"
},
"template_id": {
"description": "The journey template ID",
"type": "string"
},
"user_id": {
"description": "Recipient user ID. Can also be resolved from profile or data.",
"type": "string"
}
},
"required": [
"template_id"
],
"type": "object"
},
"name": "invoke_journey",
"outputSchema": null
},
{
"description": "List the users who currently match an audience's filter. Membership is computed, so this reflects profiles as they are right now — a profile change can move someone in or out without the audience itself being edited.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"audience_id": {
"description": "The audience ID",
"type": "string"
},
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
}
},
"required": [
"audience_id"
],
"type": "object"
},
"name": "list_audience_members",
"outputSchema": null
},
{
"description": "List the workspace's audiences. An audience is a saved filter over user profiles — a dynamic segment — so this answers \"who can I target\" and gives you the audience IDs that journey audience triggers and send requests refer to.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
}
},
"type": "object"
},
"name": "list_audiences",
"outputSchema": null
},
{
"description": "List audit events in the workspace. Useful for tracking API usage and changes.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "Pagination cursor",
"type": "string"
}
},
"type": "object"
},
"name": "list_audit_events",
"outputSchema": null
},
{
"description": "List the steps of an automation run in order, with what happened at each. Send steps carry a message_id to follow with get_message.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"run_id": {
"description": "The automation run id",
"type": "string"
}
},
"required": [
"run_id"
],
"type": "object"
},
"name": "list_automation_run_steps",
"outputSchema": null
},
{
"description": "List automation runs, newest first. Filter by automation template, status, or a created_at window to find a run that stalled or errored, then read its steps with list_automation_run_steps. Journey runs are listed by list_journey_runs instead.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "next_cursor from a previous response",
"type": "string"
},
"end_date": {
"description": "Inclusive upper bound on created_at, ISO 8601 date or timestamp",
"type": "string"
},
"limit": {
"description": "Runs per page, 1 to 50. Defaults to 20.",
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"start_date": {
"description": "Inclusive lower bound on created_at, ISO 8601 date or timestamp",
"type": "string"
},
"status": {
"description": "Comma-separated run statuses to filter on, e.g. PROCESSED,ERROR",
"type": "string"
},
"template_id": {
"description": "Comma-separated automation template ids to filter on",
"type": "string"
}
},
"type": "object"
},
"name": "list_automation_runs",
"outputSchema": null
},
{
"description": "List the workspace's automation templates, each with its template ID and whether it has a published or draft version. Answers \"what automations already exist here\" — this only reads the catalog, it never runs one.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"version": {
"description": "Return only templates in this state. Omit to return every automation template regardless of state.",
"enum": [
"published",
"draft"
],
"type": "string"
}
},
"type": "object"
},
"name": "list_automations",
"outputSchema": null
},
{
"description": "List the workspace's brands. A brand is the reusable logo, colors and email styling a notification template renders with; this gives you the brand IDs a template's brand reference points at.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
}
},
"type": "object"
},
"name": "list_brands",
"outputSchema": null
},
{
"description": "List broadcasts in the workspace.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "Pagination cursor from a previous response",
"type": "string"
},
"limit": {
"description": "Max broadcasts per page",
"type": "integer"
}
},
"type": "object"
},
"name": "list_broadcasts",
"outputSchema": null
},
{
"description": "List the users in a bulk job.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "Pagination cursor",
"type": "string"
},
"job_id": {
"description": "The bulk job ID",
"type": "string"
}
},
"required": [
"job_id"
],
"type": "object"
},
"name": "list_bulk_users",
"outputSchema": null
},
{
"description": "List the digest instances for a digest schedule. Each instance is the events accumulated so far for one user against that schedule, so this shows what is waiting to go out and answers why a digest has not arrived yet — it is still accumulating, or it has nothing in it.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"limit": {
"description": "Maximum instances to return. Defaults to 20; the API caps this at 100.",
"type": "number"
},
"schedule_id": {
"description": "The digest schedule id, in the form \"sch/{uuid}\"",
"type": "string"
}
},
"required": [
"schedule_id"
],
"type": "object"
},
"name": "list_digest_instances",
"outputSchema": null
},
{
"description": "List the steps of a journey run in order, with each node and what happened at it. This is how to see where a run stopped and why.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"run_id": {
"description": "The journey run id",
"type": "string"
}
},
"required": [
"run_id"
],
"type": "object"
},
"name": "list_journey_run_steps",
"outputSchema": null
},
{
"description": "List journey runs, newest first. Filter by journey, status, or a created_at window to find a run that stalled or errored, then read its steps with list_journey_run_steps.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "next_cursor from a previous response",
"type": "string"
},
"end_date": {
"description": "Inclusive upper bound on created_at, ISO 8601 date or timestamp",
"type": "string"
},
"limit": {
"description": "Runs per page, 1 to 50. Defaults to 20.",
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"start_date": {
"description": "Inclusive lower bound on created_at, ISO 8601 date or timestamp",
"type": "string"
},
"status": {
"description": "Comma-separated run statuses to filter on, e.g. PROCESSED,ERROR",
"type": "string"
},
"template_id": {
"description": "Comma-separated journey ids to filter on",
"type": "string"
}
},
"type": "object"
},
"name": "list_journey_runs",
"outputSchema": null
},
{
"description": "List published versions of a journey-scoped notification template, ordered most recent first.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"journey_id": {
"description": "The journey template ID that owns this notification",
"type": "string"
},
"notification_id": {
"description": "The notification template ID",
"type": "string"
}
},
"required": [
"notification_id",
"journey_id"
],
"type": "object"
},
"name": "list_journey_template_versions",
"outputSchema": null
},
{
"description": "List notification templates scoped to a journey. Journey-scoped templates can only be used by send nodes within the same journey. Call this to discover template IDs before wiring send nodes in replace_journey.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "Check the response's paging.more before calling again — false means every template already came back, and calling again with the same arguments returns the same page, not new data. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"journey_id": {
"description": "The journey template ID. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"limit": {
"description": "Page size (1–100)",
"type": "number"
}
},
"required": [
"journey_id"
],
"type": "object"
},
"name": "list_journey_templates",
"outputSchema": null
},
{
"description": "List published versions of a journey, ordered most recent first.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"journey_id": {
"description": "The journey template ID",
"type": "string"
}
},
"required": [
"journey_id"
],
"type": "object"
},
"name": "list_journey_versions",
"outputSchema": null
},
{
"description": "List journey templates in the workspace, returning the journey IDs and version state of each. Optionally filter by version (published or draft).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "If a response has no cursor, every journey already came back — calling this again with the same arguments returns the same page, not new data. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"version": {
"description": "Filter by version state. Defaults to published, and the two are never combined in one call. If you don't know whether the journey you want is published or still a draft, calling this twice — once per value — is the correct way to check both, not a repeat.",
"enum": [
"published",
"draft"
],
"type": "string"
}
},
"type": "object"
},
"name": "list_journeys",
"outputSchema": null
},
{
"description": "List the workspace's lists. A list is an explicit, subscription-based group of users — someone is on it because they were subscribed, not because they match a rule. Optionally filter by an id pattern such as \"example.list.*\".",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"pattern": {
"description": "Filter by list id pattern, where * matches a segment — for example \"example.list.*\". Omit to return every list.",
"type": "string"
}
},
"type": "object"
},
"name": "list_lists",
"outputSchema": null
},
{
"description": "List messages you've previously sent. Filter by status, recipient, notification, provider, tags, or tenant.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"archived": {
"description": "This NARROWS, it does not widen: true returns ONLY archived messages, excluding every active one. Omit it entirely to search active messages — the default view for a normal delivery question. Setting it true is not the thorough or safe choice; it is a different, much smaller result set.",
"type": "boolean"
},
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"enqueued_after": {
"description": "ISO 8601 timestamp; only return messages enqueued after this time",
"type": "string"
},
"event": {
"description": "Filter by event ID",
"type": "string"
},
"list": {
"description": "Filter by list ID",
"type": "string"
},
"messageId": {
"description": "Filter by message ID",
"type": "string"
},
"notification": {
"description": "Filter by notification ID",
"type": "string"
},
"provider": {
"description": "Filter by provider key (e.g. sendgrid, twilio)",
"items": {
"type": "string"
},
"type": "array"
},
"recipient": {
"description": "Filter by recipient user ID",
"type": "string"
},
"status": {
"description": "Filter by status (e.g. DELIVERED, UNDELIVERABLE)",
"items": {
"type": "string"
},
"type": "array"
},
"tag": {
"description": "Filter by metadata tags",
"items": {
"type": "string"
},
"type": "array"
},
"tags": {
"description": "Comma-delimited list of tags",
"type": "string"
},
"tenant_id": {
"description": "Filter by tenant ID",
"type": "string"
},
"traceId": {
"description": "Filter by trace ID",
"type": "string"
}
},
"type": "object"
},
"name": "list_messages",
"outputSchema": null
},
{
"description": "List the checks recorded against one notification submission. Checks are the gates a submission has to clear before it goes out, so a failing check here is the reason a template is stuck rather than live.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"notification_id": {
"description": "The notification template ID",
"type": "string"
},
"submission_id": {
"description": "The submission ID whose checks to list",
"type": "string"
}
},
"required": [
"notification_id",
"submission_id"
],
"type": "object"
},
"name": "list_notification_checks",
"outputSchema": null
},
{
"description": "List the version history of a notification template — each published version with when it was created. Use this to say what changed and when, or to find the version string get_notification accepts.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"limit": {
"description": "Maximum versions to return per page. Defaults to 10, which is also the maximum.",
"type": "number"
},
"notification_id": {
"description": "The notification template ID",
"type": "string"
}
},
"required": [
"notification_id"
],
"type": "object"
},
"name": "list_notification_versions",
"outputSchema": null
},
{
"description": "List notification templates, newest first. Pass tags to return only templates carrying ALL of the given tags. Page through the rest with cursor.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"tags": {
"description": "Only return templates carrying ALL of these tags, matched case-insensitively on the tag name shown in a template's tags field (e.g. [\"onboarding\"]). Omit to list every template.",
"items": {
"minLength": 1,
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"name": "list_notifications",
"outputSchema": null
},
{
"description": "List preference changes, newest first. Each entry is one change a user made to one subscription topic, with the value before it where there was one. Pass user_id to answer \"when did this user opt out, and of what?\"; omit it to read the whole environment. Page with paging.cursor while paging.more is true.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "paging.cursor from a previous response",
"type": "string"
},
"limit": {
"description": "Entries per page, 1 to 100. Defaults to 25.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"since": {
"description": "Only changes at or after this time, as an ISO 8601 date or date-time. A date alone is the start of that day in UTC.",
"type": "string"
},
"tenant_id": {
"description": "Narrow to the changes the user made in one tenant context. Requires user_id.",
"type": "string"
},
"user_id": {
"description": "Return only this user's changes. Omit to read every change in the environment.",
"type": "string"
}
},
"type": "object"
},
"name": "list_preference_logs",
"outputSchema": null
},
{
"description": "List the workspace's preference sections, each with the topics inside it. One call returns the whole opt-in surface: everything a user could subscribe to or opt out of. This is what the workspace DEFINES — use get_user_preferences for what a particular person actually chose.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "list_preference_sections",
"outputSchema": null
},
{
"description": "List the subscription topics inside one preference section. A topic is the individual thing a user opts in or out of, and its ID is what get_user_preference_topic takes.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"section_id": {
"description": "Id of the preference section",
"type": "string"
}
},
"required": [
"section_id"
],
"type": "object"
},
"name": "list_preference_topics",
"outputSchema": null
},
{
"description": "List saved preview device sets. Every workspace has a read-only Courier Recommended set that runs can use without creating a set first.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "list_preview_device_sets",
"outputSchema": null
},
{
"description": "List the email clients a preview can render on. Each device has a pvd_ id, a display name, and fields to filter by: category, app, platform, os, os_version and theme. Use these ids in a device set or in create_preview_run.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "list_preview_devices",
"outputSchema": null
},
{
"description": "List a template's preview runs, newest first.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "Pagination cursor from a previous response",
"type": "string"
},
"limit": {
"description": "Max runs per page",
"exclusiveMinimum": 0,
"type": "integer"
},
"template_id": {
"description": "The notification template id (nt_...)",
"type": "string"
}
},
"required": [
"template_id"
],
"type": "object"
},
"name": "list_preview_runs",
"outputSchema": null
},
{
"description": "List the provider integrations Courier supports and the configuration each one expects. This is the catalog of what COULD be connected, not what this workspace has configured — use list_providers for that. Answers \"what can I connect Courier to\" and \"what do I need in order to set up this provider\".",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"channel": {
"description": "Return only providers serving this channel, for example email, sms or push.",
"type": "string"
},
"keys": {
"description": "Comma-separated provider keys to return, for example \"sendgrid,twilio\".",
"type": "string"
},
"name": {
"description": "Substring match against the provider's display name.",
"type": "string"
}
},
"type": "object"
},
"name": "list_provider_catalog",
"outputSchema": null
},
{
"description": "List configured provider integrations for the workspace.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
}
},
"type": "object"
},
"name": "list_providers",
"outputSchema": null
},
{
"description": "List the workspace's routing strategies, returning metadata only. A routing strategy decides which channel a notification takes and in what order. Use this to find the rs_-prefixed strategy ID that get_routing_strategy needs for the full definition.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"limit": {
"description": "Maximum strategies to return per page. Defaults to 20; the API caps this at 100.",
"type": "number"
}
},
"type": "object"
},
"name": "list_routing_strategies",
"outputSchema": null
},
{
"description": "List notification templates associated with a routing strategy. Useful for checking linked templates before archiving.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "Pagination cursor",
"type": "string"
},
"limit": {
"description": "Max results per page (default 20, max 100)",
"type": "number"
},
"routing_strategy_id": {
"description": "The routing strategy ID (rs_ prefix)",
"type": "string"
}
},
"required": [
"routing_strategy_id"
],
"type": "object"
},
"name": "list_routing_strategy_notifications",
"outputSchema": null
},
{
"description": "List notification templates configured for a tenant.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "Pagination cursor",
"type": "string"
},
"limit": {
"description": "Max results per page (default 20, max 100)",
"type": "number"
},
"tenant_id": {
"description": "The tenant ID",
"type": "string"
}
},
"required": [
"tenant_id"
],
"type": "object"
},
"name": "list_tenant_templates",
"outputSchema": null
},
{
"description": "List the users associated with one tenant. Use this to confirm whether someone actually belongs to the tenant whose branding or preferences you are reasoning about.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"limit": {
"description": "Maximum users to return per page. Defaults to 20; the API caps this at 100.",
"type": "number"
},
"tenant_id": {
"description": "The tenant ID",
"type": "string"
}
},
"required": [
"tenant_id"
],
"type": "object"
},
"name": "list_tenant_users",
"outputSchema": null
},
{
"description": "List the workspace's tenants. A tenant is a customer or organisation whose users, branding and preferences are scoped separately; this answers \"what tenants do I have\" and gives you the tenant IDs get_tenant needs.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"limit": {
"description": "Maximum tenants to return per page.",
"type": "number"
}
},
"type": "object"
},
"name": "list_tenants",
"outputSchema": null
},
{
"description": "List all push/device tokens for a user.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id"
],
"type": "object"
},
"name": "list_user_push_tokens",
"outputSchema": null
},
{
"description": "List the tenants a user belongs to. Preferences and branding can be scoped per tenant, so this tells you which tenant-scoped settings could apply to this user at all before you go looking for them.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"cursor": {
"description": "For fetching the next page. This is an opaque token — never decode it, edit it, or rebuild it. Pass it back exactly as it appeared in the previous response's cursor field, byte for byte. Omit this entirely when you don't have one from a prior response of this exact call.",
"type": "string"
},
"limit": {
"description": "Maximum tenants to return per page.",
"type": "number"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id"
],
"type": "object"
},
"name": "list_user_tenants",
"outputSchema": null
},
{
"description": "Partially update a user profile via JSON Patch (RFC 6902). Use add/replace/remove operations on specific profile paths.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"patch": {
"description": "Array of JSON Patch operations to apply to the profile",
"items": {
"additionalProperties": false,
"properties": {
"op": {
"description": "Patch operation (add, remove, replace, move, copy, test)",
"type": "string"
},
"path": {
"description": "JSON pointer path (e.g. /email, /phone_number)",
"type": "string"
},
"value": {
"description": "Value for the operation (any JSON type)"
}
},
"required": [
"op",
"path"
],
"type": "object"
},
"type": "array"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"patch"
],
"type": "object"
},
"name": "patch_profile",
"outputSchema": null
},
{
"description": "Apply a JSON Patch (RFC 6902) to a specific push token.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"patch": {
"description": "Array of JSON Patch operations",
"items": {
"additionalProperties": false,
"properties": {
"op": {
"description": "Patch operation (add, remove, replace, move, copy, test)",
"type": "string"
},
"path": {
"description": "JSON pointer path",
"type": "string"
},
"value": {
"description": "Value for the operation (any JSON type)"
}
},
"required": [
"op",
"path"
],
"type": "object"
},
"type": "array"
},
"token": {
"description": "The token identifier",
"type": "string"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"token",
"patch"
],
"type": "object"
},
"name": "patch_user_token",
"outputSchema": null
},
{
"description": "Publish the current draft of a journey, making it live and invokable. Pass version to roll back to a prior published version instead of publishing the draft. Returns 404 if there is no draft to publish.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"journey_id": {
"description": "The journey template ID to publish",
"type": "string"
},
"version": {
"description": "Historical version to roll back to (e.g. \"v001\"). Omit to publish the current draft.",
"type": "string"
}
},
"required": [
"journey_id"
],
"type": "object"
},
"name": "publish_journey",
"outputSchema": null
},
{
"description": "Publish the current draft of a journey-scoped notification template. Optionally pass version to roll back to a prior version.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"journey_id": {
"description": "The journey template ID that owns this notification",
"type": "string"
},
"notification_id": {
"description": "The notification template ID",
"type": "string"
},
"version": {
"description": "Version to roll back to (e.g. \"v1\"). Omit to publish current draft.",
"type": "string"
}
},
"required": [
"notification_id",
"journey_id"
],
"type": "object"
},
"name": "publish_journey_template",
"outputSchema": null
},
{
"description": "Publish a notification template, making it available for sending. Must be called before send_message_template unless the template was created with state: 'PUBLISHED'. Publishes the current draft by default; pass version (e.g. 'v001') to publish a specific historical version. Returns 204 on success.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"notification_id": {
"description": "The notification template ID to publish",
"type": "string"
},
"version": {
"description": "Historical version to publish (e.g. v001); omit to publish current draft",
"type": "string"
}
},
"required": [
"notification_id"
],
"type": "object"
},
"name": "publish_notification",
"outputSchema": null
},
{
"description": "Publish the workspace's preferences page. Takes a snapshot of every section with its topics under a new published version, making the current state visible on the hosted preferences page.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "publish_preferences",
"outputSchema": null
},
{
"description": "Publish a version of a tenant notification template.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"template_id": {
"description": "The template ID",
"type": "string"
},
"tenant_id": {
"description": "The tenant ID",
"type": "string"
},
"version": {
"description": "Version to publish (e.g. v1, latest); defaults to latest if omitted",
"type": "string"
}
},
"required": [
"tenant_id",
"template_id"
],
"type": "object"
},
"name": "publish_tenant_template",
"outputSchema": null
},
{
"description": "Replace a broadcast's content with an Elemental document. Saved as a draft unless state is PUBLISHED.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"broadcast_id": {
"description": "The broadcast id",
"type": "string"
},
"content": {
"additionalProperties": {},
"description": "Elemental content, e.g. { \"version\": \"2022-01-01\", \"elements\": [...] }. version defaults when omitted.",
"type": "object"
},
"state": {
"description": "Template state. Defaults to DRAFT.",
"enum": [
"DRAFT",
"PUBLISHED"
],
"type": "string"
}
},
"required": [
"broadcast_id",
"content"
],
"type": "object"
},
"name": "put_broadcast_content",
"outputSchema": null
},
{
"description": "Replace the elemental content of a journey-scoped notification template. Overwrites all elements. The template stays a draft; making it live is a separate step this tool cannot perform.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"elements": {
"description": "Array of elemental content nodes. Likely must be wrapped in a channel block, the same way create_journey_template's content requires — not independently confirmed for this call, but they write the same field. Example: [{ type: \"channel\", channel: \"email\", elements: [{ type: \"text\", content: \"Hello!\" }] }].",
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array"
},
"journey_id": {
"description": "The journey template ID that owns this notification. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"notification_id": {
"description": "The notification template ID. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"state": {
"description": "Template state after update. Must be \"DRAFT\". These tools cannot publish.",
"enum": [
"DRAFT"
],
"type": "string"
},
"version": {
"description": "Content version string (e.g. \"2022-01-01\"). Server defaults when omitted.",
"type": "string"
}
},
"required": [
"notification_id",
"journey_id",
"elements"
],
"type": "object"
},
"name": "put_journey_template_content",
"outputSchema": null
},
{
"description": "Set locale-specific content overrides for a journey-scoped notification template. Each element override must reference an existing element by its id. The template stays a draft; making it live is a separate step this tool cannot perform.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"elements": {
"description": "Array of element overrides with id and locale-specific content",
"items": {
"additionalProperties": {},
"properties": {
"id": {
"description": "Target element ID to override, from a prior get_journey_template or get_journey_template_content response. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"journey_id": {
"description": "The journey template ID that owns this notification. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"locale_id": {
"description": "Locale identifier (e.g. es, fr, pt-BR)",
"type": "string"
},
"notification_id": {
"description": "The notification template ID. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"state": {
"description": "Template state after update. Must be \"DRAFT\". These tools cannot publish.",
"enum": [
"DRAFT"
],
"type": "string"
}
},
"required": [
"notification_id",
"journey_id",
"locale_id",
"elements"
],
"type": "object"
},
"name": "put_journey_template_locale",
"outputSchema": null
},
{
"description": "Replace the elemental content of a V2 notification template. Overwrites all elements. Use channel elements to target specific channels. Multi-channel example: elements: [{ type: \"channel\", channel: \"email\", elements: [{ type: \"meta\", title: \"Hello\" }, { type: \"text\", content: \"Email body\" }] }, { type: \"channel\", channel: \"push\", elements: [{ type: \"meta\", title: \"Hello\" }, { type: \"text\", content: \"Push body\" }] }, { type: \"channel\", channel: \"inbox\", elements: [{ type: \"text\", content: \"Inbox plain text only\" }] }]. The template stays a draft; making it live is a separate step this tool cannot perform.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"elements": {
"description": "Array of elemental content nodes",
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array"
},
"notification_id": {
"description": "The notification template ID (nt_ prefix). Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"state": {
"description": "Must be \"DRAFT\". These tools cannot publish.",
"enum": [
"DRAFT"
],
"type": "string"
},
"version": {
"description": "Content version string (e.g. \"2022-01-01\"). Server defaults when omitted.",
"type": "string"
}
},
"required": [
"notification_id",
"elements"
],
"type": "object"
},
"name": "put_notification_content",
"outputSchema": null
},
{
"description": "Update a single element within a V2 notification template. The template stays a draft; making it live is a separate step this tool cannot perform.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"channels": {
"description": "Channels this element applies to",
"items": {
"type": "string"
},
"type": "array"
},
"data": {
"additionalProperties": {},
"description": "Element data payload",
"type": "object"
},
"element_id": {
"description": "The element ID to update, from a prior get_notification or get_notification_draft_content response. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"if": {
"description": "Conditional expression for element visibility",
"type": "string"
},
"loop": {
"description": "Loop expression for repeating elements",
"type": "string"
},
"notification_id": {
"description": "The notification template ID (nt_ prefix). Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"ref": {
"description": "Reference identifier",
"type": "string"
},
"state": {
"description": "Must be \"DRAFT\". These tools cannot publish.",
"enum": [
"DRAFT"
],
"type": "string"
},
"type": {
"description": "Element type (e.g. text, action, image, divider, meta)",
"type": "string"
}
},
"required": [
"notification_id",
"element_id",
"type"
],
"type": "object"
},
"name": "put_notification_element",
"outputSchema": null
},
{
"description": "Set locale-specific content overrides for a V2 notification template. Each element override must reference an existing element by its id. Example for Spanish locale: { notification_id: \"nt_01abc\", locale_id: \"es\", elements: [{ id: \"elem_meta_1\", title: \"Restablecer contraseña\" }, { id: \"elem_text_1\", content: \"Haga clic en el enlace para restablecer su contraseña.\" }] }. The template stays a draft; making it live is a separate step this tool cannot perform.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"elements": {
"description": "Array of element overrides with id and locale-specific content",
"items": {
"additionalProperties": {},
"properties": {
"id": {
"description": "Target element ID to override, from a prior get_notification or get_notification_draft_content response. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
},
"locale_id": {
"description": "Locale identifier (e.g. es, fr, pt-BR)",
"type": "string"
},
"notification_id": {
"description": "The notification template ID (nt_ prefix). Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"state": {
"description": "Must be \"DRAFT\". These tools cannot publish.",
"enum": [
"DRAFT"
],
"type": "string"
}
},
"required": [
"notification_id",
"locale_id",
"elements"
],
"type": "object"
},
"name": "put_notification_locale",
"outputSchema": null
},
{
"description": "Release a digest schedule early — send what users have collected so far now instead of waiting for the scheduled time. A 204 is also returned when the schedule has no in-progress instances to release.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"schedule_id": {
"description": "The digest schedule id, in the form \"sch/{uuid}\"",
"type": "string"
}
},
"required": [
"schedule_id"
],
"type": "object"
},
"name": "release_digest",
"outputSchema": null
},
{
"description": "Release one recipient's held digest for a topic now, instead of waiting for its schedule. Use it to preview a digest, or to let a user flush their own, without releasing everyone else on the schedule. There is no release-everyone form of this call; use release_digest with a schedule id for that.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"section_id": {
"description": "Id of the preference section the topic belongs to",
"type": "string"
},
"tenant_id": {
"description": "The recipient's tenant, when they were sent to as part of one",
"type": "string"
},
"topic_id": {
"description": "Id of the digest topic",
"type": "string"
},
"user_id": {
"description": "The recipient whose digest to release",
"type": "string"
}
},
"required": [
"section_id",
"topic_id",
"user_id"
],
"type": "object"
},
"name": "release_user_digest",
"outputSchema": null
},
{
"description": "Remove a user from all tenants.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id"
],
"type": "object"
},
"name": "remove_all_user_tenants",
"outputSchema": null
},
{
"description": "Remove a user from a tenant.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"tenant_id": {
"description": "The tenant ID",
"type": "string"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"tenant_id"
],
"type": "object"
},
"name": "remove_user_from_tenant",
"outputSchema": null
},
{
"description": "Rename a broadcast. Content and channel are unchanged.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"broadcast_id": {
"description": "The broadcast id",
"type": "string"
},
"name": {
"description": "The new name",
"type": "string"
}
},
"required": [
"broadcast_id",
"name"
],
"type": "object"
},
"name": "rename_broadcast",
"outputSchema": null
},
{
"description": "Replace (update) a journey draft. Full document replacement — include all nodes and properties in the body, the trigger included; anything omitted is deleted. The journey stays a draft; making the change live is a separate step this tool cannot perform. This is where send, delay, branch and exit nodes are added, and send node template IDs must already be scoped to this journey. The result carries a \"verification\" object read back from the server after the write — check it every time. verified:true means what you asked for is what saved. verified:false names what did not: \"fieldMismatches\" for node fields that failed to land, \"nodeCountMismatch\" for a node dropped or added, and \"unknownTemplateReferences\" for a send node pointing at a template id this journey does not have — almost always a mistyped id, so re-copy it from the create_journey_template or get_journey response it came from. Fix the specific thing named and send the corrected document. Re-sending an identical call changes nothing, and every replace_journey overwrites the whole draft again. An \"errorKind\" of \"unauthorized\" means the write itself succeeded and only the read-back was refused: report that as unconfirmed, never as a failed write.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Whether the journey is active.",
"type": "boolean"
},
"journey_id": {
"description": "The journey template ID to update. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"name": {
"description": "Journey display name",
"type": "string"
},
"nodes": {
"description": "Complete array of journey nodes: the trigger first, a terminal exit last, and everything else between them. Use server-assigned node ids from get_journey — do NOT invent new ids. Send node example: { type: \"send\", channel: \"email\", message: { template: \"nt_journey_1\" } } — the template goes inside message, never at node level, and the id is a journey-scoped one returned by create_journey_template rather than a workspace template id. Copy that id character-for-character from the create_journey_template or get_journey response you got it from — never retype or reconstruct it from memory, since a single dropped or altered character produces a different, non-existent id and the reference silently fails to resolve. channel must always be set to one of \"email\", \"sms\", \"push\", \"inbox\", \"slack\", or \"msteams\" on every send node — do not omit it even though the field is optional. An unset channel makes Studio silently render the node as email: for sms, push, and inbox sends this means the wrong title, an Email Address field shown instead of the real recipient field, no provider picker, and a hard-blocked \"+Create message\" button, with nothing shown to warn the user. The stored recipient data is not lost and delivery is not affected — this only breaks how the journey looks and works for a human editing it in Studio. Delay node example: { type: \"delay\", mode: \"duration\", duration: \"PT1H\" }. Branch node example: { type: \"branch\", paths: [{ conditions: [\"data.plan\", \"is equal\", \"pro\"], nodes: [] }], default: { nodes: [] } } — paths and default are both required, and the key inside a path is \"conditions\", not \"condition\".",
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array"
},
"state": {
"description": "Must be \"DRAFT\". These tools cannot publish.",
"enum": [
"DRAFT"
],
"type": "string"
}
},
"required": [
"journey_id",
"name",
"nodes"
],
"type": "object"
},
"name": "replace_journey",
"outputSchema": null
},
{
"description": "Replace the draft of a journey-scoped notification template. Full document replacement. Call publish_journey_template afterwards to make it live.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"journey_id": {
"description": "The journey template ID that owns this notification",
"type": "string"
},
"notification": {
"additionalProperties": false,
"description": "Full notification template definition",
"properties": {
"brand": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
{
"type": "null"
}
]
},
"content": {
"additionalProperties": false,
"properties": {
"elements": {
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array"
},
"scope": {
"enum": [
"default",
"strict"
],
"type": "string"
},
"version": {
"const": "2022-01-01",
"type": "string"
}
},
"required": [
"version",
"elements"
],
"type": "object"
},
"name": {
"type": "string"
},
"subscription": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"topic_id": {
"type": "string"
}
},
"required": [
"topic_id"
],
"type": "object"
},
{
"type": "null"
}
]
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"tags",
"brand",
"subscription",
"content"
],
"type": "object"
},
"notification_id": {
"description": "The notification template ID",
"type": "string"
},
"state": {
"description": "\"PUBLISHED\" to publish immediately after replace",
"type": "string"
}
},
"required": [
"notification_id",
"journey_id",
"notification"
],
"type": "object"
},
"name": "replace_journey_template",
"outputSchema": null
},
{
"description": "Replace a notification template entirely (full document PUT). The template stays a draft; making it live is a separate step this tool cannot perform.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"notification": {
"additionalProperties": false,
"description": "Full notification template payload",
"properties": {
"brand": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Brand to apply, or null for none. Required on every call — never omit this key, and never send {}."
},
"content": {
"additionalProperties": false,
"description": "Elemental content, required on every call. Example: { version: \"2022-01-01\", elements: [{ type: \"text\", content: \"Hello!\" }] }.",
"properties": {
"elements": {
"description": "Elemental content nodes",
"items": {
"additionalProperties": {},
"type": "object"
},
"type": "array"
},
"version": {
"description": "Content version identifier, e.g. \"2022-01-01\"",
"type": "string"
}
},
"required": [
"version",
"elements"
],
"type": "object"
},
"name": {
"description": "Template display name",
"type": "string"
},
"routing": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"strategy_id": {
"description": "From a get_routing_strategy or list_notifications/get_notification response for THIS template's own intended strategy — never an id borrowed from an unrelated template found while searching for one.",
"type": "string"
}
},
"required": [
"strategy_id"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Routing strategy reference, or null to use the workspace default. Required on every call — never omit this key, and never send {}: the API rejects both an absent routing key and an empty object; if you have no strategy id, send null explicitly."
},
"subscription": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"topic_id": {
"type": "string"
}
},
"required": [
"topic_id"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Subscription topic reference, or null for none. Required on every call — never omit this key, and never send {}."
},
"tags": {
"description": "Tag list (use [] if none)",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"name",
"tags",
"brand",
"subscription",
"routing",
"content"
],
"type": "object"
},
"notification_id": {
"description": "The notification template ID to replace. Copy it exactly, character for character, from the response that returned it — never retype it from memory or reconstruct it.",
"type": "string"
},
"state": {
"description": "Must be \"DRAFT\". These tools cannot publish.",
"enum": [
"DRAFT"
],
"type": "string"
}
},
"required": [
"notification_id",
"notification"
],
"type": "object"
},
"name": "replace_notification",
"outputSchema": null
},
{
"description": "Replace a preference section. Full document replacement; missing optional fields are cleared. Topics attached to the section are unaffected.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"has_custom_routing": {
"description": "Whether the section defines custom routing for its topics",
"type": "boolean"
},
"name": {
"description": "Human-readable name for the section",
"type": "string"
},
"routing_options": {
"description": "Default channels for the section. Omit to clear.",
"items": {
"enum": [
"direct_message",
"email",
"push",
"sms",
"webhook",
"inbox"
],
"type": "string"
},
"type": "array"
},
"section_id": {
"description": "Id of the preference section",
"type": "string"
}
},
"required": [
"section_id",
"name"
],
"type": "object"
},
"name": "replace_preference_section",
"outputSchema": null
},
{
"description": "Replace a topic within a section. Full document replacement: omitted optional fields are cleared, except `digest`, which is left untouched when omitted. Pass `digest: null` to turn a digest off.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"allowed_preferences": {
"description": "Preference controls a recipient may customize. Omit to clear.",
"items": {
"enum": [
"snooze",
"channel_preferences"
],
"type": "string"
},
"type": "array"
},
"default_status": {
"description": "Default subscription status applied when a recipient has not set their own",
"enum": [
"OPTED_OUT",
"OPTED_IN",
"REQUIRED"
],
"type": "string"
},
"digest": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"audience_id": {
"description": "Optional audience the digest is scoped to",
"type": "string"
},
"categories": {
"description": "Retention rules per category key. Defaults to a single `digest` category.",
"items": {
"additionalProperties": false,
"properties": {
"category_key": {
"description": "Key identifying the category within the digest",
"type": "string"
},
"limit": {
"description": "How many collected events reach the rendered digest. Defaults to 10.",
"type": "integer"
},
"retain": {
"description": "Which collected events survive the limit",
"enum": [
"FIRST",
"LAST",
"HIGHEST",
"LOWEST",
"NONE"
],
"type": "string"
},
"sort_key": {
"description": "Data key to rank events by. Required when retain is HIGHEST or LOWEST.",
"type": "string"
}
},
"required": [
"category_key"
],
"type": "object"
},
"type": "array"
},
"schedules": {
"description": "The cadences this digest delivers on. At least one is required.",
"items": {
"additionalProperties": false,
"properties": {
"day_of_month": {
"description": "Required when frequency is monthly",
"type": "integer"
},
"day_of_week": {
"description": "Required when frequency is weekly",
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"days_of_week": {
"description": "Required when frequency is custom_days",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"type": "array"
},
"disabled": {
"description": "Whether the schedule is disabled",
"type": "boolean"
},
"frequency": {
"description": "How often the digest delivers. `instant` delivers each event immediately.",
"enum": [
"instant",
"daily",
"weekdays",
"weekly",
"custom_days",
"monthly"
],
"type": "string"
},
"is_default": {
"description": "The schedule recipients are placed on when they have not chosen one",
"type": "boolean"
},
"schedule_id": {
"description": "Id of an existing schedule to update. Omit to create a new one.",
"type": "string"
},
"time": {
"description": "24-hour local delivery time, HH:MM. Required for every frequency except instant.",
"type": "string"
},
"timezone": {
"description": "IANA timezone for `time` and the day fields, e.g. America/New_York",
"type": "string"
}
},
"required": [
"frequency"
],
"type": "object"
},
"minItems": 1,
"type": "array"
},
"template_id": {
"description": "The notification template that renders the digest",
"type": "string"
},
"trigger_empty": {
"description": "Deliver the digest even when nothing was collected",
"type": "boolean"
}
},
"required": [
"template_id",
"schedules"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Batch this topic's notifications into a scheduled digest. Omit to leave any existing digest untouched; pass null to turn it off."
},
"include_unsubscribe_header": {
"description": "Whether to include a list-unsubscribe header on emails for this topic",
"type": "boolean"
},
"name": {
"description": "Human-readable name for the preference topic",
"type": "string"
},
"routing_options": {
"description": "Default channels delivered for this topic. Omit to clear.",
"items": {
"enum": [
"direct_message",
"email",
"push",
"sms",
"webhook",
"inbox"
],
"type": "string"
},
"type": "array"
},
"section_id": {
"description": "Id of the preference section",
"type": "string"
},
"topic_data": {
"additionalProperties": {},
"description": "Arbitrary metadata associated with the topic. Omit to clear.",
"type": "object"
},
"topic_id": {
"description": "Id of the subscription preference topic",
"type": "string"
}
},
"required": [
"section_id",
"topic_id",
"name",
"default_status"
],
"type": "object"
},
"name": "replace_preference_topic",
"outputSchema": null
},
{
"description": "Replace a preview device set's name and devices. This is a full replace, so send every device the set should keep. The Courier Recommended set cannot be changed.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"device_ids": {
"description": "Device ids (pvd_...) from list_preview_devices. An id the catalog does not list is rejected.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
"device_set_id": {
"description": "The device set id (pvs_...)",
"type": "string"
},
"name": {
"description": "The new name",
"minLength": 1,
"type": "string"
}
},
"required": [
"device_set_id",
"name",
"device_ids"
],
"type": "object"
},
"name": "replace_preview_device_set",
"outputSchema": null
},
{
"description": "Fully replace a user profile (PUT). All existing data is overwritten; include every field you want to keep.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"profile": {
"additionalProperties": {},
"description": "Complete profile data to replace with",
"type": "object"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"profile"
],
"type": "object"
},
"name": "replace_profile",
"outputSchema": null
},
{
"description": "Replace a routing strategy. Full document replacement; missing optional fields are cleared.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"channels": {
"additionalProperties": {},
"description": "Per-channel delivery configuration. Omit to clear.",
"type": "object"
},
"description": {
"description": "Description. Omit to clear.",
"type": "string"
},
"name": {
"description": "Human-readable name",
"type": "string"
},
"providers": {
"additionalProperties": {},
"description": "Per-provider delivery configuration. Omit to clear.",
"type": "object"
},
"routing": {
"additionalProperties": false,
"description": "Routing tree",
"properties": {
"channels": {
"description": "Ordered list of channel names",
"items": {
"type": "string"
},
"type": "array"
},
"method": {
"description": "Deliver to all channels or stop after first success",
"enum": [
"all",
"single"
],
"type": "string"
}
},
"required": [
"method",
"channels"
],
"type": "object"
},
"routing_strategy_id": {
"description": "The routing strategy ID",
"type": "string"
},
"tags": {
"description": "Tags. Omit to clear.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"routing_strategy_id",
"name",
"routing"
],
"type": "object"
},
"name": "replace_routing_strategy",
"outputSchema": null
},
{
"description": "Create or replace a tenant notification template (draft unless published is true).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"channels": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"brand_id": {
"description": "Brand applied when delivering on this channel",
"type": "string"
},
"if": {
"description": "Expression; the channel is used only when truthy",
"type": "string"
},
"metadata": {
"additionalProperties": false,
"properties": {
"utm": {
"additionalProperties": false,
"properties": {
"campaign": {
"type": "string"
},
"content": {
"type": "string"
},
"medium": {
"type": "string"
},
"source": {
"type": "string"
},
"term": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"override": {
"additionalProperties": {},
"description": "Channel-specific overrides, e.g. email subject/from or push title/icon",
"type": "object"
},
"providers": {
"description": "Providers eligible for this channel, in preference order",
"items": {
"type": "string"
},
"type": "array"
},
"routing_method": {
"description": "\"all\" delivers via every provider; \"single\" stops after the first success",
"enum": [
"all",
"single"
],
"type": "string"
},
"timeouts": {
"additionalProperties": false,
"properties": {
"channel": {
"description": "Whole-channel timeout in ms",
"type": "number"
},
"provider": {
"description": "Per-provider timeout in ms",
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"description": "Per-channel delivery configuration, keyed by channel name. Example: { \"email\": { \"providers\": [\"sendgrid\"], \"routing_method\": \"single\" } }",
"type": "object"
},
"content": {
"additionalProperties": false,
"description": "Elemental content document. Example: { \"version\": \"2022-01-01\", \"elements\": [{ \"type\": \"meta\", \"title\": \"Welcome\" }, { \"type\": \"text\", \"content\": \"Thanks for signing up.\" }] }",
"properties": {
"elements": {
"description": "Elemental nodes. Channel and group containers nest to any depth",
"items": {
"anyOf": [
{
"anyOf": [
{
"additionalProperties": false,
"properties": {
"align": {
"enum": [
"center",
"left",
"right",
"full"
],
"type": "string"
},
"background_color": {
"type": "string"
},
"border_color": {
"type": "string"
},
"border_size": {
"type": "string"
},
"channels": {
"description": "Restrict this element to these channels",
"items": {
"type": "string"
},
"type": "array"
},
"content": {
"description": "The text to render",
"type": "string"
},
"font_size": {
"description": "CSS px size, e.g. \"16px\"",
"type": "string"
},
"format": {
"const": "markdown",
"description": "Set to \"markdown\" to render markdown",
"type": "string"
},
"if": {
"description": "Expression; the element renders only when truthy",
"type": "string"
},
"line_height": {
"type": "string"
},
"locales": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
}
},
"type": "object"
},
"description": "Overrides keyed by locale code",
"type": "object"
},
"loop": {
"description": "Expression resolving to a list to repeat this element over",
"type": "string"
},
"padding": {
"type": "string"
},
"ref": {
"description": "Reference name for this element",
"type": "string"
},
"text_style": {
"enum": [
"text",
"h1",
"h2",
"h3",
"subtext"
],
"type": "string"
},
"type": {
"const": "text",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"channels": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/channels"
},
"if": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/if"
},
"locales": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"title": {
"type": "string"
}
},
"type": "object"
},
"description": "Overrides keyed by locale code",
"type": "object"
},
"loop": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/loop"
},
"ref": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/ref"
},
"title": {
"description": "Message title (email subject, push title, etc.)",
"type": "string"
},
"type": {
"const": "meta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"align": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/align"
},
"alt_text": {
"type": "string"
},
"border_color": {
"type": "string"
},
"border_size": {
"type": "string"
},
"channels": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/channels"
},
"href": {
"description": "Link the image points to",
"type": "string"
},
"if": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/if"
},
"locales": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"href": {
"type": "string"
},
"src": {
"type": "string"
}
},
"type": "object"
},
"description": "Overrides keyed by locale code",
"type": "object"
},
"loop": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/loop"
},
"padding": {
"type": "string"
},
"ref": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/ref"
},
"src": {
"description": "Image URL",
"type": "string"
},
"type": {
"const": "image",
"type": "string"
},
"width": {
"description": "Rendered width, e.g. \"300px\"",
"type": "string"
}
},
"required": [
"type",
"src"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"action_id": {
"description": "Identifier reported with click tracking",
"type": "string"
},
"align": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/align"
},
"background_color": {
"description": "Fill for `button`; border and label color for `secondary`",
"type": "string"
},
"border_radius": {
"type": "string"
},
"border_size": {
"type": "string"
},
"channels": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/channels"
},
"content": {
"description": "Button or link label",
"type": "string"
},
"disable_tracking": {
"description": "Skip click tracking for this href",
"type": "boolean"
},
"font_size": {
"type": "string"
},
"href": {
"description": "URL the action opens",
"type": "string"
},
"if": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/if"
},
"locales": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"href": {
"type": "string"
}
},
"type": "object"
},
"description": "Overrides keyed by locale code",
"type": "object"
},
"loop": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/loop"
},
"padding": {
"type": "string"
},
"ref": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/ref"
},
"style": {
"description": "How prominent the action is. `button` (default) is filled, `secondary` and `tertiary` are the other two button styles, and `link` is inline text",
"enum": [
"button",
"secondary",
"tertiary",
"link"
],
"type": "string"
},
"type": {
"const": "action",
"type": "string"
}
},
"required": [
"type",
"content",
"href"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"border_width": {
"type": "string"
},
"channels": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/channels"
},
"color": {
"type": "string"
},
"if": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/if"
},
"loop": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/loop"
},
"padding": {
"type": "string"
},
"ref": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/ref"
},
"type": {
"const": "divider",
"type": "string"
},
"width": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"align": {
"enum": [
"center",
"left",
"right",
"full",
"justify"
],
"type": "string"
},
"border_color": {
"type": "string"
},
"border_size": {
"type": "string"
},
"channels": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/channels"
},
"content": {
"type": "string"
},
"font_size": {
"type": "string"
},
"if": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/if"
},
"line_height": {
"type": "string"
},
"locales": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
}
},
"type": "object"
},
"description": "Overrides keyed by locale code",
"type": "object"
},
"loop": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/loop"
},
"padding": {
"type": "string"
},
"ref": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/ref"
},
"text_style": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/text_style"
},
"type": {
"const": "quote",
"type": "string"
}
},
"required": [
"type",
"content"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"channels": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/channels"
},
"content": {
"description": "Raw HTML, rendered as-is",
"type": "string"
},
"if": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/if"
},
"locales": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
}
},
"type": "object"
},
"description": "Overrides keyed by locale code",
"type": "object"
},
"loop": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/loop"
},
"ref": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/ref"
},
"type": {
"const": "html",
"type": "string"
}
},
"required": [
"type",
"content"
],
"type": "object"
}
]
},
{
"additionalProperties": false,
"properties": {
"channel": {
"description": "Channel these elements target, e.g. \"email\", \"push\", \"inbox\"",
"type": "string"
},
"channels": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/channels"
},
"elements": {
"description": "Elements rendered for this channel",
"items": {
"$ref": "#/properties/content/properties/elements/items"
},
"type": "array"
},
"if": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/if"
},
"loop": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/loop"
},
"raw": {
"additionalProperties": {},
"description": "Channel-native payload passed through untouched",
"type": "object"
},
"ref": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/ref"
},
"type": {
"const": "channel",
"type": "string"
}
},
"required": [
"type",
"channel"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"channels": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/channels"
},
"elements": {
"description": "Grouped elements",
"items": {
"$ref": "#/properties/content/properties/elements/items"
},
"type": "array"
},
"if": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/if"
},
"loop": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/loop"
},
"ref": {
"$ref": "#/properties/content/properties/elements/items/anyOf/0/anyOf/0/properties/ref"
},
"type": {
"const": "group",
"type": "string"
}
},
"required": [
"type",
"elements"
],
"type": "object"
}
]
},
"type": "array"
},
"scope": {
"description": "\"strict\" reads send data only under the `data.` prefix, e.g. {{data.name}}. Under \"default\", data is spread to the root and {{data.name}} renders empty",
"enum": [
"default",
"strict"
],
"type": "string"
},
"version": {
"const": "2022-01-01",
"description": "Elemental schema version",
"type": "string"
}
},
"required": [
"version",
"elements"
],
"type": "object"
},
"providers": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"if": {
"description": "Expression; the provider is used only when truthy",
"type": "string"
},
"override": {
"additionalProperties": {},
"description": "Provider-native payload fields merged into the request",
"type": "object"
},
"timeouts": {
"description": "Provider timeout in ms",
"type": "number"
}
},
"type": "object"
},
"description": "Per-provider configuration, keyed by provider name. Example: { \"sendgrid\": { \"override\": { \"from\": \"[email protected]\" } } }",
"type": "object"
},
"published": {
"description": "When true, publish immediately after save",
"type": "boolean"
},
"routing": {
"additionalProperties": false,
"description": "Message routing tree. Example: { \"method\": \"single\", \"channels\": [\"email\", \"sms\"] }",
"properties": {
"channels": {
"description": "Channels to attempt, in order. Entries may be names or config objects",
"items": {
"anyOf": [
{
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"channel": {
"description": "Channel name",
"type": "string"
},
"config": {
"additionalProperties": {},
"type": "object"
},
"if": {
"type": "string"
},
"method": {
"enum": [
"all",
"single"
],
"type": "string"
},
"providers": {
"items": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"config": {
"additionalProperties": {},
"type": "object"
},
"if": {
"type": "string"
},
"metadata": {
"additionalProperties": false,
"properties": {
"utm": {
"$ref": "#/properties/channels/additionalProperties/properties/metadata/properties/utm"
}
},
"type": "object"
},
"name": {
"description": "Provider name",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
{
"type": "string"
}
]
},
"type": "array"
}
},
"required": [
"channel"
],
"type": "object"
},
{
"$ref": "#/properties/routing/properties/channels/items/anyOf/1/properties/providers/items/anyOf/0"
}
]
},
"type": "array"
},
"method": {
"description": "\"all\" delivers to every channel; \"single\" stops after the first success",
"enum": [
"all",
"single"
],
"type": "string"
}
},
"required": [
"method",
"channels"
],
"type": "object"
},
"template_id": {
"description": "The template ID",
"type": "string"
},
"tenant_id": {
"description": "The tenant ID",
"type": "string"
},
"title": {
"description": "Optional title merged into template content when provided",
"type": "string"
}
},
"required": [
"tenant_id",
"template_id",
"content"
],
"type": "object"
},
"name": "replace_tenant_template",
"outputSchema": null
},
{
"description": "Resend a previously sent message. Loads the original send request and enqueues a brand-new send to the same recipient with the same content, producing a new messageId; the original message is unchanged. Rate limited per message (429 on rapid repeats).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"message_id": {
"description": "The message ID of the original message to resend",
"type": "string"
}
},
"required": [
"message_id"
],
"type": "object"
},
"name": "resend_message",
"outputSchema": null
},
{
"description": "Restore a previously deleted list.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"list_id": {
"description": "The list ID",
"type": "string"
}
},
"required": [
"list_id"
],
"type": "object"
},
"name": "restore_list",
"outputSchema": null
},
{
"description": "Run a bulk job, triggering delivery to all added users.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"job_id": {
"description": "The bulk job ID to run",
"type": "string"
}
},
"required": [
"job_id"
],
"type": "object"
},
"name": "run_bulk_job",
"outputSchema": null
},
{
"description": "Schedule a broadcast to send later to a list or audience. Cancel with cancel_broadcast_schedule.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"broadcast_id": {
"description": "The broadcast id",
"type": "string"
},
"recipient_id": {
"description": "The list or audience id",
"type": "string"
},
"recipient_type": {
"description": "Whether to send to a list or an audience",
"enum": [
"list",
"audience"
],
"type": "string"
},
"scheduled_to": {
"description": "Wall-clock time of the send with no timezone offset, e.g. 2026-10-01T09:00:00",
"type": "string"
},
"timezone": {
"description": "IANA timezone scheduled_to is expressed in, e.g. America/New_York",
"type": "string"
}
},
"required": [
"broadcast_id",
"recipient_type",
"recipient_id",
"scheduled_to"
],
"type": "object"
},
"name": "schedule_broadcast",
"outputSchema": null
},
{
"description": "Send a broadcast now to every member of a list or audience. This delivers real messages.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"broadcast_id": {
"description": "The broadcast id",
"type": "string"
},
"recipient_id": {
"description": "The list or audience id",
"type": "string"
},
"recipient_type": {
"description": "Whether to send to a list or an audience",
"enum": [
"list",
"audience"
],
"type": "string"
}
},
"required": [
"broadcast_id",
"recipient_type",
"recipient_id"
],
"type": "object"
},
"name": "send_broadcast",
"outputSchema": null
},
{
"description": "Send a message to a user using inline title and body content (no template). Optionally specify routing channels. API reference: https://www.courier.com/docs/api-reference/send/send-a-message.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"body": {
"description": "Message body",
"type": "string"
},
"channels": {
"description": "Channel names to route through (e.g. email, sms, push). Omit to use default routing.",
"items": {
"type": "string"
},
"type": "array"
},
"data": {
"additionalProperties": {},
"description": "Key-value data to include with the message",
"type": "object"
},
"method": {
"default": "all",
"description": "Routing method: deliver to all channels or stop after first success",
"enum": [
"all",
"single"
],
"type": "string"
},
"title": {
"description": "Message title",
"type": "string"
},
"user_id": {
"description": "The recipient user ID",
"type": "string"
}
},
"required": [
"user_id",
"title",
"body"
],
"type": "object"
},
"name": "send_message",
"outputSchema": null
},
{
"description": "Send a message to a user using a published notification template. Only published templates can be sent; publishing a draft is a separate operation. Example: { user_id: \"user-123\", template: \"nt_01abc123\", data: { name: \"Alex\", resetUrl: \"https://app.example.com/reset\" } }.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"channels": {
"description": "Channel names to route through. Omit to use template routing config.",
"items": {
"type": "string"
},
"type": "array"
},
"data": {
"additionalProperties": {},
"description": "Key-value data for template variables",
"type": "object"
},
"method": {
"default": "all",
"description": "Routing method",
"enum": [
"all",
"single"
],
"type": "string"
},
"template": {
"description": "Template ID or notification slug",
"type": "string"
},
"user_id": {
"description": "The recipient user ID",
"type": "string"
}
},
"required": [
"user_id",
"template"
],
"type": "object"
},
"name": "send_message_template",
"outputSchema": null
},
{
"description": "Send a message to all subscribers of a list using inline title and body content. API reference: https://www.courier.com/docs/api-reference/send/send-a-message.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"body": {
"description": "Message body",
"type": "string"
},
"channels": {
"description": "Channel names to route through. Omit to use default routing.",
"items": {
"type": "string"
},
"type": "array"
},
"data": {
"additionalProperties": {},
"description": "Key-value data to include",
"type": "object"
},
"list_id": {
"description": "The list ID to send to",
"type": "string"
},
"method": {
"default": "all",
"description": "Routing method",
"enum": [
"all",
"single"
],
"type": "string"
},
"title": {
"description": "Message title",
"type": "string"
}
},
"required": [
"list_id",
"title",
"body"
],
"type": "object"
},
"name": "send_message_to_list",
"outputSchema": null
},
{
"description": "Send a message to all subscribers of a list using a notification template.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"channels": {
"description": "Channel names to route through. Omit to use template routing config.",
"items": {
"type": "string"
},
"type": "array"
},
"data": {
"additionalProperties": {},
"description": "Key-value data for template variables",
"type": "object"
},
"list_id": {
"description": "The list ID to send to",
"type": "string"
},
"method": {
"default": "all",
"description": "Routing method",
"enum": [
"all",
"single"
],
"type": "string"
},
"template": {
"description": "Template ID or notification slug",
"type": "string"
}
},
"required": [
"list_id",
"template"
],
"type": "object"
},
"name": "send_message_to_list_template",
"outputSchema": null
},
{
"description": "Subscribe a user to a list. Creates the list if it doesn't exist.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"list_id": {
"description": "The list ID",
"type": "string"
},
"preferences": {
"additionalProperties": false,
"description": "Optional notification preferences",
"properties": {
"categories": {
"additionalProperties": {},
"type": "object"
},
"notifications": {
"additionalProperties": {},
"type": "object"
}
},
"type": "object"
},
"user_id": {
"description": "The user ID to subscribe",
"type": "string"
}
},
"required": [
"list_id",
"user_id"
],
"type": "object"
},
"name": "subscribe_user_to_list",
"outputSchema": null
},
{
"description": "Subscribe a user to one or more lists. Creates lists that do not exist.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"lists": {
"description": "Array of lists to subscribe to",
"items": {
"additionalProperties": false,
"properties": {
"listId": {
"description": "List ID to subscribe to",
"type": "string"
},
"preferences": {
"description": "Optional notification preferences for this list"
}
},
"required": [
"listId"
],
"type": "object"
},
"type": "array"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"lists"
],
"type": "object"
},
"name": "subscribe_user_to_lists",
"outputSchema": null
},
{
"description": "Trace delivery in one call. Give EXACTLY ONE of message_id (a single message) or trace_id (the metadata.trace_id set on a send, which can span several messages). Returns each matching message with its event history, which carries the status reason when a message is undeliverable. Set include_output to also return the rendered content each provider received.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"include_output": {
"description": "Also return rendered content per provider. Off by default, since rendered email can be large.",
"type": "boolean"
},
"limit": {
"description": "Max messages to trace for a trace_id. Defaults to 10.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"message_id": {
"description": "A message id, as returned by send. Mutually exclusive with trace_id.",
"type": "string"
},
"trace_id": {
"description": "The metadata.trace_id set on the send. Mutually exclusive with message_id.",
"type": "string"
}
},
"type": "object"
},
"name": "trace_message",
"outputSchema": null
},
{
"description": "Track an inbound event that can trigger automations. Requires event name, messageId (for deduplication), and properties.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"event": {
"description": "The event name (appears as trigger in Automation Trigger node)",
"type": "string"
},
"messageId": {
"description": "Unique ID for deduplication (returns 409 if not unique)",
"type": "string"
},
"properties": {
"additionalProperties": {},
"description": "Event properties payload",
"type": "object"
},
"userId": {
"description": "User ID associated with the event",
"type": "string"
}
},
"required": [
"event",
"messageId",
"properties"
],
"type": "object"
},
"name": "track_inbound_event",
"outputSchema": null
},
{
"description": "Unsubscribe a user from a list.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"list_id": {
"description": "The list ID",
"type": "string"
},
"user_id": {
"description": "The user ID to unsubscribe",
"type": "string"
}
},
"required": [
"list_id",
"user_id"
],
"type": "object"
},
"name": "unsubscribe_user_from_list",
"outputSchema": null
},
{
"description": "Create or update an audience with a filter definition.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"audience_id": {
"description": "The audience ID",
"type": "string"
},
"description": {
"description": "Description",
"type": "string"
},
"filter": {
"anyOf": [
{
"additionalProperties": false,
"description": "A single condition evaluated against one user profile field",
"properties": {
"operator": {
"description": "Comparison to apply, e.g. \"EQ\", \"INCLUDES\", \"IS_AFTER\"",
"enum": [
"ENDS_WITH",
"EQ",
"EXISTS",
"GT",
"GTE",
"INCLUDES",
"IS_AFTER",
"IS_BEFORE",
"LT",
"LTE",
"MEMBER_OF",
"NEQ",
"OMIT",
"STARTS_WITH"
],
"type": "string"
},
"path": {
"description": "Dot-notation path into the user profile, e.g. \"title\" or \"location.city\"",
"type": "string"
},
"value": {
"description": "Value to compare against. Omit for existence checks like \"EXISTS\"",
"type": [
"string",
"number",
"boolean"
]
}
},
"required": [
"operator",
"path"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "A group combining nested filters with AND/OR",
"properties": {
"filters": {
"description": "Conditions and/or nested groups to combine",
"items": {
"$ref": "#/properties/filter"
},
"type": "array"
},
"operator": {
"description": "How the nested filters combine. The combinator lives on the group itself",
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"required": [
"operator",
"filters"
],
"type": "object"
}
],
"description": "Audience membership filter. Either a single condition ({ operator, path, value }) or a group ({ operator: \"AND\" | \"OR\", filters: [...] }) nesting to any depth. Example: { \"operator\": \"AND\", \"filters\": [{ \"operator\": \"EQ\", \"path\": \"title\", \"value\": \"Engineer\" }, { \"operator\": \"INCLUDES\", \"path\": \"tags\", \"value\": \"beta\" }] }"
},
"name": {
"description": "Display name",
"type": "string"
}
},
"required": [
"audience_id"
],
"type": "object"
},
"name": "update_audience",
"outputSchema": null
},
{
"description": "Replace an existing brand with new values.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"brand_id": {
"description": "The brand ID to update",
"type": "string"
},
"name": {
"description": "Brand display name",
"type": "string"
},
"settings": {
"additionalProperties": false,
"description": "Brand settings (colors, email, inapp)",
"properties": {
"colors": {
"additionalProperties": {},
"type": "object"
},
"email": {
"additionalProperties": {},
"type": "object"
},
"inapp": {
"additionalProperties": {},
"type": "object"
}
},
"type": "object"
},
"snippets": {
"additionalProperties": {},
"description": "Brand snippets",
"type": "object"
}
},
"required": [
"brand_id",
"name"
],
"type": "object"
},
"name": "update_brand",
"outputSchema": null
},
{
"description": "Update check statuses for a notification submission.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"checks": {
"description": "Checks to update",
"items": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Check ID",
"type": "string"
},
"status": {
"description": "Check status",
"enum": [
"RESOLVED",
"FAILED",
"PENDING"
],
"type": "string"
},
"type": {
"const": "custom",
"description": "Check type",
"type": "string"
}
},
"required": [
"id",
"status",
"type"
],
"type": "object"
},
"type": "array"
},
"notification_id": {
"description": "The notification template ID",
"type": "string"
},
"submission_id": {
"description": "The submission ID for the checks resource",
"type": "string"
}
},
"required": [
"notification_id",
"submission_id",
"checks"
],
"type": "object"
},
"name": "update_notification_checks",
"outputSchema": null
},
{
"description": "Replace an existing provider configuration. Full replacement — retrieve current config with get_provider first; omitted optional fields are cleared. Changing API keys or settings affects live delivery if this integration is in use.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"alias": {
"description": "Short alias",
"type": "string"
},
"provider": {
"description": "Provider key (must match existing; changing provider type is not supported)",
"type": "string"
},
"provider_id": {
"description": "The provider configuration ID",
"type": "string"
},
"settings": {
"additionalProperties": {},
"description": "Provider-specific settings",
"type": "object"
},
"title": {
"description": "Display name",
"type": "string"
}
},
"required": [
"provider_id",
"provider"
],
"type": "object"
},
"name": "update_provider",
"outputSchema": null
},
{
"description": "Set the default notification preference for a subscription topic on a tenant. This controls tenant-level defaults — it does NOT set per-user preferences (use the user preferences API for that). The topic_id must already exist as a subscription topic in the workspace; a 404 means the topic has not been created yet. Example: { tenant_id: \"acme\", topic_id: \"marketing-updates\", status: \"OPTED_IN\", has_custom_routing: true, custom_routing: [\"email\", \"push\"] }.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"custom_routing": {
"description": "Default channels when has_custom_routing is enabled",
"items": {
"enum": [
"direct_message",
"email",
"push",
"sms",
"webhook",
"inbox"
],
"type": "string"
},
"type": "array"
},
"has_custom_routing": {
"description": "When true, use custom_routing instead of template defaults",
"type": "boolean"
},
"status": {
"description": "Subscription status for the topic",
"enum": [
"OPTED_IN",
"OPTED_OUT",
"REQUIRED"
],
"type": "string"
},
"tenant_id": {
"description": "The tenant ID",
"type": "string"
},
"topic_id": {
"description": "The subscription topic ID — must already exist in the workspace. A 404 response means the topic does not exist; create it in the Preferences Editor first.",
"type": "string"
}
},
"required": [
"tenant_id",
"topic_id",
"status"
],
"type": "object"
},
"name": "update_tenant_preference",
"outputSchema": null
},
{
"description": "Create or update a translation for a specific locale. API reference: https://www.courier.com/docs/api-reference/translations/update-translations-by-locale.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"body": {
"description": "Translation content (PO file format)",
"type": "string"
},
"domain": {
"default": "default",
"description": "Translation domain",
"type": "string"
},
"locale": {
"description": "Locale code (e.g. en_US, fr_FR)",
"type": "string"
}
},
"required": [
"locale",
"body"
],
"type": "object"
},
"name": "update_translation",
"outputSchema": null
},
{
"description": "Update a user's preference for a specific subscription topic (opt in, opt out, or set channel preferences).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"custom_routing": {
"description": "Custom channel routing order",
"items": {
"type": "string"
},
"type": "array"
},
"digest_schedule_id": {
"description": "Put the user on one of the topic's digest schedules. Pass null to clear their choice and fall back to the default schedule.",
"type": [
"string",
"null"
]
},
"has_custom_routing": {
"description": "Whether custom channel routing is set",
"type": "boolean"
},
"status": {
"description": "Preference status",
"enum": [
"OPTED_IN",
"OPTED_OUT",
"REQUIRED"
],
"type": "string"
},
"tenant_id": {
"description": "Update the preference for this tenant context only",
"type": "string"
},
"topic_id": {
"description": "The subscription topic ID",
"type": "string"
},
"user_id": {
"description": "The user ID",
"type": "string"
}
},
"required": [
"user_id",
"topic_id",
"status"
],
"type": "object"
},
"name": "update_user_preference_topic",
"outputSchema": null
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:871da2e4462faf37120158afd4d07e8241637a0c81c0133306ba5fdf8c5a0140 | sha256sum