Your AWS SES. Your dedicated Mailat. See how it works
Documentation

Pause

Request, response and authentication details for your Mailat instance.

← All API operations
POST/api/v1/automations/{uuid}/pause

Pause pauses an automation POST /api/v1/automations/:uuid/pause

Authentication & compatibility

This operation requires an active human session. API keys cannot call it. Additional role or MFA checks may apply.

Mailat application, account or shared resource API. Individual operations can require configured external services; this label is not a runtime-readiness guarantee.

Contract 2026-10-04. Your running instance's /api/v1/openapi.json is authoritative for its deployed release.

Request

Set MAILAT_BASE_URL to your instance origin (without /api/v1) and MAILAT_TOKEN to an appropriate credential. Replace path placeholders and example data before running. These examples do not execute in this page.

cURL request
curl --request POST "$MAILAT_BASE_URL/api/v1/automations/{uuid}/pause" \
  --header "Authorization: Bearer $MAILAT_TOKEN"

Parameters

path
uuidstringrequired

Responses

HTTP statuses and body shapes below come from the pinned contract. Not every shared error applies to every request. Retain the original idempotency key when retrying a send.

200 · Success

application/json

responseobject
Fields
codeintegerrequired
dataall of · nullable
Variant 1object
Fields · model.Automation
completedCountinteger (int64)
createdAtstring (date-time)
descriptionstring
enrolledCountinteger (int64)
idinteger (int64)
inProgressCountinteger (int64)
namestring
orgIdinteger (int64)
statusstring

draft, active, paused

triggerConfigobject
Additional valuesany value
triggerTypestring

contact.created, contact.subscribed, tag.added, etc.

updatedAtstring (date-time)
uuidstring
workflowall of · nullable
Variant 1object
Fields · model.Workflow
edgesarray
Each itemobject
Fields · model.WorkflowEdge
idstring
labelstring
sourcestring
sourceHandlestring
targetstring
targetHandlestring
typestring
nodesarray
Each itemobject
Fields · model.WorkflowNode
dataobject
Fields · model.WorkflowNodeData
configobject
Additional valuesany value

Nested or recursive type. See the downloadable OpenAPI for its complete definition.

labelstring
typestring
idstring
positionobject
Fields · model.WorkflowPosition
xnumber
ynumber
typestring

trigger, email, delay, condition, action

messagestringrequired
400 · Invalid input

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
401 · Missing, expired or revoked authentication

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
403 · Insufficient permission

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
404 · Resource not found

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
409 · Conflict or changed idempotency payload

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
410 · Recovery cursor expired; resynchronize

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
429 · Rate limit exceeded; respect Retry-After
Header: Retry-Afterinteger

Seconds until the next fixed-minute request window.

minimum: 1

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
500 · Internal failure; retain the idempotency key

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
Download the full OpenAPI contract