Update Waiting Area by ID

Authorizations

Authorization

string

header

required

Provide a Bearer Token

Body

application/json

name

string

custom_identifier

string

department_id

string | null

additional_departments

object[] | null

This field acts as a sync operation, meaning that the departments that are passed in will be the only departments that are assigned to the waiting area. Any departments that are not passed in will be removed from the waiting area.

Show child attributes

additional_documents

object[] | null

When an item has an id property, it will be updated. When an item does not have an id property, it will be created. When an item has a deleted_at property, it will be deleted.

Show child attributes

assigned_users

object[] | null

This field acts as a sync operation, meaning that the users that are passed in will be the only users that are assigned to the waiting area. Any users that are not passed in will be removed from the waiting area.

Show child attributes

data_fields

object[]

When an item has an id property, it will be updated. When an item does not have an id property, it will be created. When an item has a deleted_at property, it will be deleted.

Show child attributes

schedules

any[]

Minimum array length: 7

agent_post_call_redirent_link

string

The link to redirect the agent to after a call

Example:

"https://www.google.com"

claimant_post_call_redirent_link

string

The link to redirect the claimant to after a call

Example:

"https://www.google.com"

holding_page_redirent_link

string

The link to redirect to for the holding page

Example:

"https://www.google.com"

features_call_recording_enable

boolean

Whether call recording is enabled

Example:

true

features_breakout_room_enable

boolean

Whether breakout rooms are enabled

Example:

true

features_webcam_access_agent_enable

boolean

Whether webcam access is enabled for agents

Example:

true

features_webcam_access_claimant_enable

boolean

Whether webcam access is enabled for claimants

Example:

true

features_webcam_background_blurring_enable

boolean

Whether webcam background blurring is enabled

Example:

true

features_microphone_access_enable

boolean

Whether microphone access is enabled

Example:

true

Whether screen sharing is enabled

Example:

true

features_messages_chat_enable

boolean

Whether chat messages are enabled

Example:

true

features_participant_list_enable

boolean

Whether the participant list is enabled

Example:

true

features_bandwidth

string

The bandwidth setting

Example:

"high"

messages_welcome_message

any

messages_holding_message

any

messages_post_call_message

any

messages_sms_default_message

any

messages_email_default_message

any

theme_waiting_area_video_url

string

The waiting area video URL

Example:

"https://www.youtube.com/watch?v=1234567890"

theme_waiting_area_hold_music_url

string

The waiting area hold music URL

Example:

"https://www.youtube.com/watch?v=1234567890"

theme_color

string

The theme color

Example:

"#000000"

support_page_content

any

alert_phone_number

string | null

The phone number to send alerts to

Example:

447123456789

alert_time_in_minutes

integer | null

The time in minutes to send alerts after the user joined the room

Example:

5

Response

200 - application/json

The request has succeeded.

The response is of type any.

API documentation

Authorisation

Scheduled Calls

Waiting Areas

Update Waiting Area by ID

Authorizations

Body

Response