Skip to main content
POST
Preview potential automation effects without applying any changes.
This read-only endpoint requires resources.read and an explicitly selected project. Supply the typed operation and input for an event, contact, audience membership, or topic preference change. Inspect matched_automations and resumable_runs; the result is an estimate (exact: false) and does not authorize or reserve a later mutation. Personal-key mutations default to suppression; explicitly triggering live effects also requires automations.trigger and current role access.

Authorizations

Authorization
string
header
required

Integration key for backend workloads, or a scoped personal key (sr_user_) for account discovery and supported project operations. MCP accepts only personal keys.

Headers

X-Sendrealm-Project-Id
string<uuid>

Explicit project context. Required for personal-key project resource calls; integration keys retain their configured default. MCP clients supply project_id in each tool call instead.

Body

application/json

Read-only preview; does not apply changes or trigger automations.

operation
enum<string>
required

Mutation to preview.

Available options:
ingest_event
input
object
required

Response

Successful response

data
object
required
status
integer
metadata
object
{key}