TWtwilio
FlexV1FlexFlow

Changed on
post/v1/FlexFlows/{Sid}

Request

  • Base URL
    https://flex-api.twilio.com
  • URL
    https://flex-api.twilio.com/v1/FlexFlows/{Sid}
  • Auth
    HTTP basic

Path parameters

Sidstring required

The SID of the Flex Flow resource to update.

Request body application/x-www-form-urlencoded

FriendlyNamestring

A descriptive string that you create to describe the Flex Flow resource.

ChatServiceSidstring

The SID of the chat service.

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

ContactIdentitystring

The channel contact's Identity.

Enabledboolean

Whether the new Flex Flow is enabled.

IntegrationType'studio' | 'external' | 'task'

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

Integration.FlowSidstring

The SID of the Studio Flow. Required when integrationType is studio.

Integration.Urlstring uri

The URL of the external webhook. Required when integrationType is external.

Integration.WorkspaceSidstring

The Workspace SID for a new Task. Required when integrationType is task.

Integration.WorkflowSidstring

The Workflow SID for a new Task. Required when integrationType is task.

Integration.Channelstring

The Task Channel SID (TCXXXX) or unique name (e.g., sms) to use for the Task that will be created. Applicable and required when integrationType is task. The default value is default.

Integration.Timeoutinteger

The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when integrationType is task, not applicable otherwise.

Integration.Priorityinteger

The Task priority of a new Task. The default priority is 0. Optional when integrationType is task, not applicable otherwise.

Integration.CreationOnMessageboolean

In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging.

LongLivedboolean

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.

JanitorEnabledboolean

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.

Integration.RetryCountinteger

The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when integrationType is studio or external, not applicable otherwise.

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.

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

Changes