Automations

Pause a live automation

Stops the automation from processing further steps for any contact, and stops new contacts from entering it, without discarding its configuration - resume to continue exactly where it left off. Requires { "confirm": true } in the body - omit it (or send false) to get back the automation's current full state with confirmationRequired: true instead, with nothing applied. Always fetch and show the caller (or end user) that state before sending confirm: true.

post/v1/projectId/{projectId}/automations/{id}/pause

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/automations/{id}/pause
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

idstring required

Request body

confirmboolean

Must be true to actually apply this action.

Response

OK - check result.hasErrors/result.confirmationRequired before assuming the action actually applied.

statusinteger

Example response

{
  "status": 200,
  "result": {
    "hasErrors": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.