v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-052012116.1 KB

StudioV1Engagement

Triggers a new Engagement for the Flow

post/v1/Flows/{FlowSid}/Engagements

Path parameters

FlowSidstring required

The SID of the Flow.

Response

sidstring nullable

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

account_sidstring nullable

The SID of the Account that created the Engagement resource.

flow_sidstring nullable

The SID of the Flow.

contact_sidstring nullable

The SID of the Contact.

contact_channel_addressstring nullable

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

{"stackTrail":"components:schemas:studio.v1.flow.engagement:properties:context","oasType":"schema","type":"unknown","description":"The current state of the execution flow. As your flow executes, we save the state in a flow context. Your widgets can access the data in the flow context as variables, either in configuration fields or in text areas as variable substitution.","nullable":true}

status'active' | 'ended'

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

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

The date and time in GMT when the Engagement was updated in ISO 8601 format.

urlstring uri nullable

The absolute URL of the resource.

linksobject nullable

The URLs of the Engagement's nested resources.