Skip to main content
PATCH
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Path Parameters

agent_id
string
required

The voice agent's id: the id from List voice agents. It is also the last part of that page's address in the app.

widget_id
string
required

The widget's id: the id from List widgets for this agent.

Body

application/json
allowed_origins
string[] | null

Allowed origins returned by the Sendora API.

avatar_url
string | null

Avatar url returned by the Sendora API.

avatar_video_live_url
string | null

Avatar video live url returned by the Sendora API.

avatar_video_pre_call_url
string | null

Avatar video pre call url returned by the Sendora API.

avatar_video_url
string | null

Avatar video url returned by the Sendora API.

Consent text returned by the Sendora API.

Maximum string length: 2000
daily_call_cap
integer | null

Daily call cap returned by the Sendora API.

Required range: x > 0
display_mode
enum<string> | null

Display mode returned by the Sendora API.

Available options:
conversation,
compact,
launcher
display_name
string | null

Display name returned by the Sendora API.

Maximum string length: 255
greeting_text
string | null

Greeting text returned by the Sendora API.

Maximum string length: 2000
is_active
boolean | null

Is active returned by the Sendora API.

launcher_icon
string | null

Launcher icon returned by the Sendora API.

launcher_media_type
enum<string> | null

Launcher media type returned by the Sendora API.

Available options:
image,
video
launcher_media_url
string | null

Launcher media url returned by the Sendora API.

Maximum string length: 1000
max_concurrent_calls
integer | null

Max concurrent calls returned by the Sendora API.

Required range: 0 < x <= 50
name
string | null

Name returned by the Sendora API.

Maximum string length: 255
position
string | null

Position returned by the Sendora API.

pre_call_form
PreCallFormField · object[] | null

Pre call form returned by the Sendora API.

Require consent returned by the Sendora API.

settings
WidgetEditorSettings · object | null

Settings returned by the Sendora API.

show_transcript
boolean | null

Show transcript returned by the Sendora API.

target_list_id
string | null

The lead list new leads from this widget are saved to: an id from List lead lists.

theme
Theme · object | null

Theme returned by the Sendora API.

Response

Successful Response

agent_id
string
required

A voice agent's id: the id from List voice agents.

allowed_origins
string[]
required

Allowed origins returned by the Sendora API.

Consent text returned by the Sendora API.

created_at
string
required

Created at returned by the Sendora API.

greeting_text
string
required

Greeting text returned by the Sendora API.

id
string
required

The widget's id. Pass it to any endpoint that takes widget_id.

is_active
boolean
required

Is active returned by the Sendora API.

max_concurrent_calls
integer
required

Max concurrent calls returned by the Sendora API.

name
string
required

Name returned by the Sendora API.

position
string
required

Position returned by the Sendora API.

pre_call_form
Pre Call Form · object[]
required

Pre call form returned by the Sendora API.

Require consent returned by the Sendora API.

show_transcript
boolean
required

Show transcript returned by the Sendora API.

theme
Theme · object
required

Theme returned by the Sendora API.

updated_at
string
required

Updated at returned by the Sendora API.

avatar_url
string | null

Avatar url returned by the Sendora API.

avatar_video_live_url
string | null

Avatar video live url returned by the Sendora API.

avatar_video_pre_call_url
string | null

Avatar video pre call url returned by the Sendora API.

avatar_video_url
string | null

Avatar video url returned by the Sendora API.

daily_call_cap
integer | null

Daily call cap returned by the Sendora API.

display_mode
enum<string>
default:conversation

Display mode returned by the Sendora API.

Available options:
conversation,
compact,
launcher
display_name
string | null

Display name returned by the Sendora API.

launcher_icon
string
default:iridescent

Launcher icon returned by the Sendora API.

launcher_media_type
enum<string> | null

Launcher media type returned by the Sendora API.

Available options:
image,
video
launcher_media_url
string | null

Launcher media url returned by the Sendora API.

settings
WidgetEditorSettings · object

Settings returned by the Sendora API.

target_list_id
string | null

The lead list new leads from this widget are saved to: an id from List lead lists.