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
|
The unique string that we created to identify the Flow resource. |
account_sid
|
The SID of the Account that created the Flow resource. |
friendly_name
|
The string that you assigned to describe the Flow. |
definition
|
JSON representation of flow definition. |
status
|
The status of the Flow. Can be: |
revision
|
The latest revision number of the Flow's definition. |
commit_message
|
Description of change made in the revision. |
valid
|
Boolean if the flow definition is valid. |
errors
|
List of error in the flow definition. |
warnings
|
List of warnings in the flow definition. |
date_created
|
The date and time in GMT when the resource was created specified in ISO 8601 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in ISO 8601 format. |
webhook_url
|
|
url
|
The absolute URL of the resource. |
links
|
The URLs of the Flow's nested resources. |
Create a Flow resource
https://studio.twilio.com/v2/Flows
Parameters
| Parameters in REST API format | |
|---|---|
friendly_name
Required
|
The string that you assigned to describe the Flow. |
status
Required
|
The status of the Flow. Can be: |
definition
Required
|
JSON representation of flow definition. |
commit_message
Optional
|
Description of change made in the revision. |
Example 1
Fetch a Flow resource
https://studio.twilio.com/v2/Flows/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Flow resource to fetch. |
Example 1
Read multiple Flow resources
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
Update a Flow resource
https://studio.twilio.com/v2/Flows/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Flow resource to fetch. |
status
Required
|
The status of the Flow. Can be: |
friendly_name
Optional
|
The string that you assigned to describe the Flow. |
definition
Optional
|
JSON representation of flow definition. |
commit_message
Optional
|
Description of change made in the revision. |
Example 1
Delete a Flow resource
https://studio.twilio.com/v2/Flows/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Flow resource to delete. |
Example 1
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.
