Pause an automation

POST/api/v1/automations/{automation}/pause

Requires anorganization API keywith the scopeautomations:write

Stops a live automation. Nobody new enters and nobody inside moves; resuming carries on where each person was, and waits that fell due meanwhile run straight away.

This endpoint takes no request body.

Parameters

Name	In	Type	Description
`automation`required	path	string	The automation identifier.

Request

POST/api/v1/automations/{automation}/pause

curl -X POST 'https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/pause' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/pause', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.post(
    "https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/pause",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->post('https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/pause');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/automations/01JBT8XQ2M9WYC3K4F6R7S8T9V/pause")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

dataobject
- idstring
- namestring
- statestringdraft | live | paused | archived
- entry_rulestringonce | every_time | cooldown
  Whether a contact may enter more than once.
- settingsobject
  - exit_eventsarray<string>
    Event names that end a run early, checked before every step.
  - exitsobject
    The full exit rules: events (with optional property filters), whether unsubscribing exits, and segments whose entry exits.
    - eventsarray<object>
    - on_unsubscribeboolean
    - on_replyboolean
      Leave the journey when the contact replies to any of its emails (auto-replies ignored).
    - segments_enteredarray<string>
  - streamstringmarketing | transactional
  - cooldown_hoursinteger
- graphobject
  The editable draft: {nodes[{id,type,config}], edges[{from,to,branch?}]}. Publishing snapshots it into a version.
- validationobject
  - okboolean
  - errorsobject
    Problems keyed by node id (nodes.<id>.<field>) or graph/settings.
- live_versionobject
  - idstring
  - numberinteger
  - published_atstring
- paused_bystringuser | breaker
- countsobject
  - in_flightinteger
    Runs that have not finished.
  - completedinteger
  - exitedinteger
  - failedinteger
  - emails_sentinteger
    Emails this automation has actually sent, across every version. Only counted on the list; 0 elsewhere.
- published_atstring
- paused_atstring
- archived_atstring
- created_atstring
- updated_atstring

Returned inside the standard envelope.

Errors

Status	When
`401`	The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
`403`	The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
`404`	No such resource in this organization.
`422`	The request was understood but the values were not acceptable.
`429`	Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.