Skip to main content
PATCH
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.

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.

承認

Authorization
string
header
必須

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.

ヘッダー

Idempotency-Key
string<uuid>
必須

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.

パスパラメータ

flow_id
string
必須

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}$
例:

"6a3b09c938da57c8f5838880"

ボディ

application/json
action
enum<string>
必須

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

利用可能なオプション:
pause,
resume,
stop,
retire,
archive,
unarchive
updated_by
string<email>
必須

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.

必須範囲: x >= 1
request_id
string

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

レスポンス

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.

利用可能なオプション:
flow
data
object