Properties
| Name | Type | Description |
|---|---|---|
| automation | object | |
| warnings | array | Returned on create and update when a step saves but should not ship as written — for example a `product` email whose body has no `{{unsubscribe_url}}` link. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/groundmail-dev/json-schema/groundmail-dev-automation-response-schema.json",
"title": "AutomationResponse",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/groundmail-dev-automations-api-openapi.yml#/components/schemas/AutomationResponse",
"type": "object",
"required": [
"automation"
],
"properties": {
"automation": {
"$ref": "#/$defs/Automation"
},
"warnings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Returned on create and update when a step saves but should not ship as written — for example a `product` email whose body has no `{{unsubscribe_url}}` link."
}
},
"$defs": {
"Automation": {
"type": "object",
"required": [
"id",
"name",
"status",
"trigger",
"steps",
"folder",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused"
]
},
"trigger": {
"$ref": "#/$defs/AutomationTrigger"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/$defs/AutomationStep"
},
"minItems": 1,
"maxItems": 20
},
"folder": {
"type": [
"string",
"null"
],
"description": "Name of the dashboard folder it is filed in, or null."
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
},
"AutomationStep": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"delay",
"send_email",
"send_sms",
"condition",
"wait_for_event"
]
}
},
"additionalProperties": true,
"description": "Step object. Shape depends on `type`:\n- `delay`: `{ type, seconds }`\n- `send_email`: `{ type, email: { from, to, subject?, html?, text?, template?, category? } }`. `category` is `transactional` or `product` (`newsletter` is rejected); when omitted the step sends as its template's category, else `transactional`. Merge fields accept a default: `{{event.data.name | default:\"there\"}}`. Values merged into `html` are HTML-escaped, and `{{unsubscribe_url}}` is filled in with the managed unsubscribe link.\n- `send_sms`: `{ type, sms: { to, body, from?, messaging_service_sid? } }` (requires Twilio integration)\n- `condition`: `{ type, path, operator, value? }` (false stops the run)\n- `wait_for_event`: `{ type, event, timeout_seconds?, on_timeout? }` (`on_timeout` is `continue` or `fail`, default `fail`)\n"
},
"AutomationTrigger": {
"type": "object",
"required": [
"type",
"event"
],
"properties": {
"type": {
"type": "string",
"enum": [
"event"
]
},
"event": {
"type": "string"
},
"cancel_on_events": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 20,
"description": "When any listed event fires for the same recipient, cancel queued/running/waiting runs for this automation."
},
"once_per_contact": {
"type": "boolean",
"description": "Enrol each recipient at most once, ever. Matched on the trigger event's `email` or `user_id`. A later matching event is reported in `enrollment_skips` instead of starting a run."
},
"cooldown_days": {
"type": "integer",
"minimum": 1,
"maximum": 3650,
"description": "Do not enrol the same recipient again within this many days of their last run on this automation. Ignored when `once_per_contact` is true."
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/groundmail-dev-automation-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.