Skip to main content
POST
Create or clone Flow

Authorizations

x-api-key
string
header
required

Your ps_ API key

Body

application/json
name
string
required

Flow name. Non-empty; trimmed.

Minimum string length: 1
Example:

"Agendamento v2"

categories
enum<string>[]
required

One or more of Meta's closed set. A value outside it is 400 FLOW_CATEGORY_INVALID.

Minimum array length: 1
Available options:
SIGN_UP,
SIGN_IN,
APPOINTMENT_BOOKING,
LEAD_GENERATION,
CONTACT_US,
CUSTOMER_SUPPORT,
SURVEY,
OTHER
Example:
cloneFromFlowId
string

The LOCAL id of the source Flow — the id field GET /v1/flows returns, never the metaFlowId. Confusing the two is the natural mistake and we cannot detect it for you: both are opaque strings, and Meta answers with its own error. metaFlowId is also nullable (a draft never pushed), so an id from Meta would have nothing to resolve. Omit to create from scratch; null is refused.

Example:

"cmf1a2b3c4d5e6f7g8h9i0j1"

Response

Flow created in DRAFT