Expand

Flow

Flows are individual workflows that you create. Flow definitions are expressed as instances of a JSON schema.

Note: Flow definitions are null in the Flows List Resource. To retrieve the Flow definition, use the Fetch method.

Flow properties

Resource Properties in REST API format
`sid`	sid<FW> Not PII The unique string that we created to identify the Flow resource.
`account_sid`	sid<AC> Not PII The SID of the Account that created the Flow resource.
`friendly_name`	string Not PII The string that you assigned to describe the Flow.
`definition`	object Not PII JSON representation of flow definition.
`status`	enum:status Not PII The status of the Flow. Can be: `draft` or `published`.
`revision`	integer Not PII The latest revision number of the Flow's definition.
`commit_message`	string Not PII Description of change made in the revision.
`valid`	boolean Not PII Boolean if the flow definition is valid.
`errors`	object[] Not PII List of error in the flow definition.
`warnings`	object[] Not PII List of warnings in the flow definition.
`date_created`	date_time<iso8601> Not PII The date and time in GMT when the resource was created specified in ISO 8601 format.
`date_updated`	date_time<iso8601> Not PII The date and time in GMT when the resource was last updated specified in ISO 8601 format.
`webhook_url`	url Not PII
`url`	url Not PII The absolute URL of the resource.
`links`	uri_map Not PII The URLs of the Flow's nested resources.

Create a Flow resource

post

https://studio.twilio.com/v2/Flows

Parameters

Parameters in REST API format
`friendly_name` Required	post string Not PII The string that you assigned to describe the Flow.
`status` Required	post ienum:status Not PII The status of the Flow. Can be: `draft` or `published`.
`definition` Required	post object Not PII JSON representation of flow definition.
`commit_message` Optional	post string Not PII Description of change made in the revision.

Example 1

Loading Code Sample...

Show sample response

Example JSON response

Create Flow

Fetch a Flow resource

get

https://studio.twilio.com/v2/Flows/{Sid}

Parameters

Parameters in REST API format

sid

Path

get sid<FW> Not PII

The SID of the Flow resource to fetch.

Example 1

Loading Code Sample...

Show sample response

Example JSON response

Fetch Flow

Read multiple Flow resources

get

https://studio.twilio.com/v2/Flows

Note: Flow definitions are null in the Flows List Resource. To retrieve the Flow definition, use the Fetch method.

Example 1

Loading Code Sample...

Show sample response

Example JSON response

Read Flows

Update a Flow resource

post

https://studio.twilio.com/v2/Flows/{Sid}

Parameters

Parameters in REST API format
`sid` Path	post sid<FW> Not PII The SID of the Flow resource to fetch.
`status` Required	post ienum:status Not PII The status of the Flow. Can be: `draft` or `published`.
`friendly_name` Optional	post string Not PII The string that you assigned to describe the Flow.
`definition` Optional	post object Not PII JSON representation of flow definition.
`commit_message` Optional	post string Not PII Description of change made in the revision.

Example 1

Loading Code Sample...

Show sample response

Example JSON response

Update Flow

Delete a Flow resource

delete

https://studio.twilio.com/v2/Flows/{Sid}

Parameters

Parameters in REST API format

sid

Path

delete sid<FW> Not PII

The SID of the Flow resource to delete.

Example 1

Loading Code Sample...

Show sample response

Example JSON response

Delete Flow

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

Loading Code Sample...

Example JSON response