Sign in
StudioV2Execution

Triggers a new Execution for the Flow

Triggers a new Execution for the Flow

post/v2/Flows/{FlowSid}/Executions

Path parameters

FlowSidstring required

The SID of the Excecution's Flow.

Response

Created

sidstring nullable

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

account_sidstring nullable

The SID of the Account that created the Execution resource.

flow_sidstring nullable

The SID of the Flow.

contact_channel_addressstring nullable

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.

contact_sidstring nullable

The SID of the Contact.

flow_versioninteger nullable

The Flow version number at the time of Execution creation.

{"stackTrail":"components:schemas:studio.v2.flow.execution:properties:context","oasType":"schema","type":"unknown","description":"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.","extensionFields":{"x-twilio":{"pii":{"handling":"standard","deleteSla":30}}},"nullable":true}
status'active' | 'ended'

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

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

initiated_bystring nullable

The SID or identifier that triggered this Execution. For example, a Call SID if triggered by an incoming call, a Message SID if triggered by an incoming message, a Request SID if triggered by a REST API request, and so on.

urlstring uri nullable

The absolute URL of the resource.

linksobject nullable

The URLs of nested resources.

Changes

Changed in 5 of the 50 revisions of this API.35

  • v2c52cffd904251See the full diff
    • ○

      added the optional property initiated_by to the response with the 201 status

      response-optional-property-added

  • v2cbcd359438902See the full diff
    • ○

      added the optional property contact_sid to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property flow_version to the response with the 201 status

      response-optional-property-added

  • v288ca5d3cb0bb11See the full diff
    • ▲

      the context response's property type/format changed from object/ to / for status 201

      response-property-type-changed

    • ○

      the Parameters request property type/format was generalized from object/ to /

      request-property-type-generalized

  • v2d6e7767d27a52See the full diff
    • ▲

      the Parameters request property type/format changed from / to object/

      request-property-type-changed

    • ▲

      the context response's property type/format changed from / to object/ for status 201

      response-property-type-changed

  • v2531843bd1ac81See the full diff
    • ○

      api tag StudioV2Execution added

      api-tag-added