API Reference

Update a Flow

put
https://api.prtmb.com/api/v2/accounts//audiences//flows/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
required

This parameter indicates which Account owns the collections and resources reference by the request.

As a convenience, the slug me may be used in place of the account_id in any URL where it is
required. When me is used it will be replaced with the account_id of the current User.

required

This parameter indicates which Audience is referenced by the request.

As a convenience, the slug default may be used in place of the audience_id in any URL where it is
required. When default is used it will be replaced with the audience_id of the default audience
for the referenced Account.

string
required

Flow ID

Body Params

Success

Update a Flow

boolean

A boolean indicating that the Flow is running when true.

Note: before active can be true a valid flow_trigger and flow_action must exist.

string | null

An optional text description of the Flow.

flow_action
object
flow_trigger
object
string
required

A human-readable display name, unique within the Audience.

string
required

A URL safe name, unique within the Audience.

Response

Callback

Updated about 4 years ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 4 years ago