Create a Flow.

POST /v2/Flows

Account sid auth token

Studio flows

Create a Flow.

application/x-www-form-urlencoded

Body

FriendlyName string Required

The string that you assigned to describe the Flow.
Status string Required

The status of the Flow. Can be: draft or published.

Values are draft or published.
Definition Required

JSON representation of flow definition.
CommitMessage string

Description of change made in the revision.

Responses

201 application/json

Created
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- sid string | null
  
  The unique string that we created to identify the Flow resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FW[0-9a-fA-F]{32}$.
- account_sid string | null
  
  The SID of the Account that created the Flow resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- friendly_name string | null
  
  The string that you assigned to describe the Flow.
- definition
  
  JSON representation of flow definition.
- status string
  
  The status of the Flow. Can be: draft or published.
  
  Values are draft or published.
- revision integer
  
  The latest revision number of the Flow's definition.
  
  Default value is 0.
- commit_message string | null
  
  Description of change made in the revision.
- valid boolean | null
  
  Boolean if the flow definition is valid.
- errors array | null
  
  List of error in the flow definition.
- warnings array | null
  
  List of warnings in the flow definition.
- date_created string(date-time) | null
  
  The date and time in GMT when the resource was created specified in ISO 8601 format.
- date_updated string(date-time) | null
  
  The date and time in GMT when the resource was last updated specified in ISO 8601 format.
- webhook_url string(uri) | null
- url string(uri) | null
  
  The absolute URL of the resource.
- links object(uri-map) | null
  
  The URLs of the Flow's nested resources.

POST /v2/Flows

curl \
 --request POST 'https://studio.twilio.com/v2/Flows' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Status=published&Definition=%7B%22initial_state%22%3A+%22Trigger%22%7D&FriendlyName=Test+Flow'

Request example

{"Status"=>"published", "Definition"=>"{\"initial_state\": \"Trigger\"}", "FriendlyName"=>"Test Flow"}

Response examples (201)

{
  "sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "revisions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Revisions",
    "executions": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions",
    "test_users": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TestUsers"
  },
  "valid": true,
  "errors": [],
  "status": "published",
  "revision": 1,
  "warnings": [],
  "definition": {
    "initial_state": "Trigger"
  },
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "webhook_url": "http://webhooks.twilio.com/v1/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2017-11-06T12:00:00Z",
  "date_updated": null,
  "friendly_name": "Test Flow",
  "commit_message": null
}