Triggers a new Execution for the Flow

POST /v2/Flows/{FlowSid}/Executions
Account sid auth token

Executions of Studio flows

Triggers a new Execution for the Flow

Path parameters

  • FlowSid string Required

    The SID of the Excecution's Flow.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FW[0-9a-fA-F]{32}$.

application/x-www-form-urlencoded

Body

  • To string(phone-number) Required

    The Contact phone number to start a Studio Flow Execution, available as variable {{contact.channel.address}}.

  • From string(phone-number) Required

    The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable {{flow.channel.address}}. For SMS, this can also be a Messaging Service SID.

  • Parameters

    JSON data that will be added to the Flow's context and that can be accessed as variables inside your Flow. For example, if you pass in Parameters={"name":"Zeke"}, a widget in your Flow can reference the variable {{flow.data.name}}, which returns "Zeke". Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.

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 Execution resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FN[0-9a-fA-F]{32}$.

    • account_sid string | null

      The SID of the Account that created the Execution resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • flow_sid string | null

      The SID of the Flow.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FW[0-9a-fA-F]{32}$.

    • contact_channel_address string | null

      The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as name@company.com. Client identifiers are formatted client:name.

    • context

      The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.

    • status string

      The status of the Execution. Can be: active or ended.

      Values are active or ended.

    • 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.

    • url string(uri) | null

      The absolute URL of the resource.

    • links object(uri-map) | null

      The URLs of nested resources.
POST /v2/Flows/{FlowSid}/Executions 
curl \
 --request POST 'https://studio.twilio.com/v2/Flows/{FlowSid}/Executions' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'To=%2B18001234567&From=%2B18007654321&ExternalId=random_external_id&Parameters=%7B%22first_name%22%3A%22Foo%22%7D'
Request example 
{"To"=>"+18001234567", "From"=>"+18007654321", "ExternalId"=>"random_external_id", "Parameters"=>"{\"first_name\":\"Foo\"}"}
Response examples (201) 
{
  "sid": "FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "steps": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps",
    "execution_context": "https://studio.twilio.com/v2/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context"
  },
  "status": "active",
  "context": {},
  "flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "contact_channel_address": "+18001234567"
}