Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-04-147365503.5 KB
FlexV1FlexFlow

get/v1/FlexFlows/{Sid}

Path parameters

Sidstring required

The SID of the Flex Flow resource to fetch.

Response

OK

account_sidstring nullable

The SID of the Account that created the Flex Flow resource and owns this Workflow.

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.

sidstring nullable

The unique string that we created to identify the Flex Flow resource.

friendly_namestring nullable

The string that you assigned to describe the resource.

chat_service_sidstring nullable

The SID of the chat service.

channel_type'web' | 'sms' | 'facebook' | 'whatsapp' | 'line' | 'custom'

The channel type. One of web, facebook, sms, whatsapp, line or custom. By default, Studio’s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If channelType is facebook, whatsapp or line, the Send to Flex widget should set the Task Channel to Programmable Chat.

contact_identitystring nullable

The channel contact's Identity.

enabledboolean nullable

Whether the Flex Flow is enabled.

integration_type'studio' | 'external' | 'task'

The software that will handle inbound messages. Integration Type can be: studio, external, or task.

{"stackTrail":"components:schemas:flex.v1.flex_flow:properties:integration","oasType":"schema","type":"unknown","description":"An object that contains specific parameters for the integration.","nullable":true}
long_livedboolean nullable

When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to false.

janitor_enabledboolean nullable

When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to false.

urlstring uri nullable

The absolute URL of the Flex Flow resource.