Triggers a new Execution for the Flow

POST /v2/Flows/{FlowSid}/Executions

Executions of Studio flows

Triggers a new Execution for the Flow

Path parameters

  • FlowSid string Required

    The SID of the Excecution's Flow.

Body

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

  • To string(phone-number) Required

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

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

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

    • contact_channel_address string | null

      The phone number, SIP address or Client identifier that triggered the Execution

    • context

      The current state of the flow

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

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

    • links object(uri-map) | null

      Nested resource URLs

    • sid string | null

      The unique string that identifies the resource

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

    • status string | null

      The status of the Execution

      Values are active or ended.

    • url string(uri) | null

      The absolute URL of the resource
POST /v2/Flows/{FlowSid}/Executions 
curl \
 -X POST https://studio.twilio.com/v2/Flows/{FlowSid}/Executions \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'From=string&To=string'
Request example 
{
  "From": "string",
  "To": "string"
}
Request examples 
{
  "From": "string",
  "To": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "contact_channel_address": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "flow_sid": "string",
  "links": {},
  "sid": "string",
  "status": "active",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "contact_channel_address": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "flow_sid": "string",
  "links": {},
  "sid": "string",
  "status": "active",
  "url": "https://example.com"
}