Update Flow Status

This API changes a flow’s lifecycle state. Requires the campaigns:create_manage permission.

PATCH /v5/flows/{flow_id}/status

cURL

pause

curl --request PATCH \
  --url https://api-{dc}.moengage.com/v5/flows/{flow_id}/status \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "action": "pause",
  "updated_by": "[e-mail]"
}
'

200

{
  "response_id": "abc-200",
  "type": "flow",
  "data": {
    "flow_id": "69f1de84f9e401a2d7d9a931",
    "status": "PAUSED"
  }
}

Lifecycle actions (pause, resume, stop, retire) accept an optional version_no and act on that version (default: the active version). archive / unarchive apply to the whole flow and reject a version_no.

Action	Allowed from	Result
pause	ACTIVE, SCHEDULED	PAUSED
resume	PAUSED	ACTIVE
stop	ACTIVE, SCHEDULED, PAUSED, RETIRED	STOPPED
retire	ACTIVE, PAUSED	RETIRED
archive	PAUSED, STOPPED, COMPLETED (and not already archived)	sets archived=true
unarchive	any archived flow	sets archived=false

Rate Limits

The rate limits are at the workspace level. A maximum of 10 requests per second, 100 requests per minute, and 6,000 requests per hour are allowed per workspace.

Authorizations

Authorization · string · header · required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format username:password.

• Username: Use your MoEngage Workspace ID (also known as the App ID). Find it in the MoEngage dashboard at Settings > Account > API keys.
• Password: Use an API key from Settings > Account > API keys.

Refer to API Key Dashboard for details on creating and managing API keys.

Headers

Idempotency-Key · string<uuid> · required

Client-generated UUID v4. Reusing the same key replays the original response instead of re-applying the transition.

X-MOE-Request-Id · string

Client-supplied trace ID. The server echoes it in the X-MOE-Request-Id response header and in response_id. If you omit it, the server generates one.

Path Parameters

flow_id · string · required

The 24-character ID of the flow. This must be the flow's own ID, not a version ID; passing a version ID returns 400.

Pattern: ^[a-f0-9]{24}$

Example:

"6a3b09c938da57c8f5838880"

Body

application/json

action · enum<string> · required

The lifecycle operation to apply. publish is not available in this phase.

Available options: pause, resume, stop, retire, archive, unarchive

updated_by · string<email> · required

Email of the user performing the action. Recorded in the audit log.

version_no · integer

Optional. For lifecycle actions (pause, resume, stop, retire), acts on this version (default: the active version). Rejected for archive / unarchive.

Required range: x >= 1

request_id · string

Optional if supplied via the X-MOE-Request-Id header; echoed in response_id.

Response

200

application/json

Flow status updated.

response_id · string

Echo of the X-MOE-Request-Id that you supplied. When you omit it, MoEngage returns the first 12 characters of a system-generated UUID.

type · enum<string>

The type of resource the response describes.

Available options: flow

data · object

Show child attributes