Sign in
FlexV1Configuration

post/v1/Configuration

Request body

object required

Response

OK

account_sidstring nullable

The SID of the Account that created the Configuration resource.

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

attributesobject nullable

An object that contains application-specific data.

status'ok' | 'inprogress' | 'notstarted'

The status of the Flex onboarding. Can be: ok, inprogress,notstarted.

taskrouter_workspace_sidstring nullable

The SID of the TaskRouter Workspace.

taskrouter_target_workflow_sidstring nullable

The SID of the TaskRouter target Workflow.

taskrouter_target_taskqueue_sidstring nullable

The SID of the TaskRouter Target TaskQueue.

taskrouter_taskqueuesobject[] nullable

The list of TaskRouter TaskQueues.

taskrouter_skillsobject[] nullable

The Skill description for TaskRouter workers.

taskrouter_worker_channelsobject nullable

The TaskRouter default channel capacities and availability for workers.

taskrouter_worker_attributesobject nullable

The TaskRouter Worker attributes.

taskrouter_offline_activity_sidstring nullable

The TaskRouter SID of the offline activity.

runtime_domainstring nullable

The URL where the Flex instance is hosted.

messaging_service_instance_sidstring nullable

The SID of the Messaging service instance.

chat_service_instance_sidstring nullable

The SID of the chat service this user belongs to.

flex_service_instance_sidstring nullable

The SID of the Flex service instance.

flex_instance_sidstring nullable

The SID of the Flex instance.

ui_languagestring nullable

The primary language of the Flex UI.

ui_attributesobject nullable

The object that describes Flex UI characteristics and settings.

ui_dependenciesobject nullable

The object that defines the NPM packages and versions to be used in Hosted Flex.

ui_versionstring nullable

The Pinned UI version.

service_versionstring nullable

The Flex Service version.

call_recording_enabledboolean nullable

Whether call recording is enabled.

call_recording_webhook_urlstring nullable

The call recording webhook URL.

crm_enabledboolean nullable

Whether CRM is present for Flex.

crm_typestring nullable

The CRM type.

crm_callback_urlstring nullable

The CRM Callback URL.

crm_fallback_urlstring nullable

The CRM Fallback URL.

crm_attributesobject nullable

An object that contains the CRM attributes.

public_attributesobject nullable

The list of public attributes, which are visible to unauthenticated clients.

plugin_service_enabledboolean nullable

Whether the plugin service enabled.

plugin_service_attributesobject nullable

The plugin service attributes.

integrationsobject[] nullable

A list of objects that contain the configurations for the Integrations supported in this configuration.

outbound_call_flowsobject nullable

The list of outbound call flows.

serverless_service_sidsstring[] nullable

The list of serverless service SIDs.

queue_stats_configurationobject nullable

Configurable parameters for Queues Statistics.

notificationsobject nullable

Configurable parameters for Notifications.

markdownobject nullable

Configurable parameters for Markdown.

urlstring uri nullable

The absolute URL of the Configuration resource.

flex_insights_hrobject nullable

Object with enabled/disabled flag with list of workspaces.

flex_insights_drilldownboolean nullable

Setting this to true will redirect Flex UI to the URL set in flex_url

flex_urlstring nullable

URL to redirect to in case drilldown is enabled.

channel_configsobject[] nullable

Settings for different limits for Flex Conversations channels attachments.

debugger_integrationobject nullable

Configurable parameters for Debugger Integration.

flex_ui_status_reportobject nullable

Configurable parameters for Flex UI Status report.

agent_conv_end_methodsobject nullable

Agent conversation end methods.

citrix_voice_vdiobject nullable

Citrix voice vdi configuration and settings.

offline_configobject nullable

Presence and presence ttl configuration

Changes