Menu

Expand
Rate this page:

Execution Resource

An Execution represents a specific person’s run through a Flow. An execution is active while the user is in the Flow, and it is considered ended when they stop or are kicked out of the Flow.

HTTP requests to Studio's REST API are protected with HTTP Basic authentication. To learn more about how Twilio handles authentication, please see our security documentation. You will use your Twilio account SID as the username and your auth token as the password for HTTP Basic authentication.

Important: When triggering flows with the API, don't forget to also configure your Twilio Phone Number with your Studio Flow. If you don't configure the phone number, users won't be able to reply to your messages or call back to your IVR.

Deprecation Notice: The contact_sid property has been deprecated and will be replaced with a static placeholder value in the v1 API. Use contact_channel_address instead to uniquely track contacts. For the best experience and latest features, upgrade to the v2 API.

Subscribe to Real-time Studio Events

Try Studio Events

You can now subscribe to Studio Events for Executions and Steps instead of polling via the REST API. Simplify your data ingestion with Event Streams for Studio.

Execution properties

Resource Properties in REST API format
sid
sid<FN> Not PII

The unique string that we created to identify the Execution resource.

account_sid
sid<AC> Not PII

The SID of the Account that created the Execution resource.

flow_sid
sid<FW> Not PII

The SID of the Flow.

contact_sid
sid<FC> Not PII

The SID of the Contact.

contact_channel_address

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
enum:status Not PII

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

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.

url
url Not PII

The absolute URL of the resource.

links
uri_map Not PII

The URLs of nested resources.

Create a new execution

post
https://studio.twilio.com/v1/Flows/{FlowSid}/Executions

Studio Rate Limits
Be sure to review Studio's rate limits when building your application.

Parameters
Parameters in REST API format
flow_sid
Path
post sid<FW> Not PII

The SID of the Excecution's Flow.

to
Required
post phone_number Not PII

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

from
Required
post phone_number Not PII

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
Optional
post object PII MTL: 30 DAYS

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.

Example 1
Loading Code Sample...
        
        

        Create Execution

        Example 2
        Loading Code Sample...
              
              
              Create a new Execution with JSON data to be added to your flow's context. You will be able to access these parameters as variables inside your Studio flow.

              Create an Execution with custom parameters

              Create a new Execution with JSON data to be added to your flow's context. You will be able to access these parameters as variables inside your Studio flow.

              Fetch a single execution

              get
              https://studio.twilio.com/v1/Flows/{FlowSid}/Executions/{Sid}
              Parameters
              Parameters in REST API format
              flow_sid
              Path
              get sid<FW> Not PII

              The SID of the Flow with the Execution resource to fetch

              sid
              Path
              get sid<FN> Not PII

              The SID of the Execution resource to fetch.

              Example 1
              Loading Code Sample...
                    
                    

                    Fetch Execution

                    Read a list of executions

                    get
                    https://studio.twilio.com/v1/Flows/{FlowSid}/Executions

                    Execution resources are listed in reverse chronological order (most recent is first).

                    Parameters
                    Parameters in REST API format
                    flow_sid
                    Path
                    get sid<FW> Not PII

                    The SID of the Flow with the Execution resources to read.

                    date_created_from
                    Optional
                    get date_time<iso8601> Not PII

                    Only show Execution resources starting on or after this ISO 8601 date-time, given as YYYY-MM-DDThh:mm:ss-hh:mm.

                    date_created_to
                    Optional
                    get date_time<iso8601> Not PII

                    Only show Execution resources starting before this ISO 8601 date-time, given as YYYY-MM-DDThh:mm:ss-hh:mm.

                    Example 1
                    Loading Code Sample...
                          
                          

                          Read Execution

                          Example 2
                          Loading Code Sample...
                                
                                
                                Executions can be filtered by the date they were created (30-day max range).

                                Read Executions Filtered by Date

                                Executions can be filtered by the date they were created (30-day max range).

                                Update an Execution

                                post
                                https://studio.twilio.com/v1/Flows/{FlowSid}/Executions/{Sid}

                                An active Execution can be updated to "ended" using the REST API. Once ended, subsequent widgets in the Flow are not processed, and any new events that Studio receives for that Execution are rejected.

                                Parameters
                                Parameters in REST API format
                                flow_sid
                                Path
                                post sid<FW> Not PII

                                The SID of the Flow with the Execution resources to update.

                                sid
                                Path
                                post sid<FN> Not PII

                                The SID of the Execution resource to update.

                                status
                                Required
                                post ienum:status Not PII

                                The status of the Execution. Can only be ended.

                                Example 1
                                Loading Code Sample...
                                      
                                      

                                      End an Active Execution

                                      Delete an execution

                                      delete
                                      https://studio.twilio.com/v1/Flows/{FlowSid}/Executions/{Sid}
                                      Parameters
                                      Parameters in REST API format
                                      flow_sid
                                      Path
                                      delete sid<FW> Not PII

                                      The SID of the Flow with the Execution resources to delete.

                                      sid
                                      Path
                                      delete sid<FN> Not PII

                                      The SID of the Execution resource to delete.

                                      Example 1
                                      Loading Code Sample...
                                            
                                            

                                            Delete Execution

                                            Rate this page:

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

                                                  Thank you for your feedback!

                                                  Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                                                  Sending your feedback...
                                                  🎉 Thank you for your feedback!
                                                  Something went wrong. Please try again.

                                                  Thanks for your feedback!

                                                  thanks-feedback-gif