authenticated

integrations

Upsert Web Widget Config

put/integrations/web-widget/config

Request

Base URL
https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
Auth
- API key in header x-api-key
- or HTTP bearer

Headers

organization-idstring nullable

x-user-idstring nullable

timezonestring

x-actor-emailstring nullable

x-request-sourcestring nullable

x-operation-idstring nullable

x-commit-messagestring nullable

x-confirmation-idstring nullable

x-chat-idstring nullable

Request body

brand_namestring nullable

brand_logo_urlstring nullable

brand_colorsobject nullable

launcher_copystring nullable

launcher_position'bottom-right' | 'bottom-left'

modal_headlinestring nullable

modal_subheadstring nullable

modal_cta_labelstring nullable

opt_in_copy_overridestring nullable

tc_urlstring nullable

privacy_urlstring nullable

trust_ratingnumber nullable

trust_review_countinteger nullable

trust_neighbor_countinteger nullable

origin_allowliststring[] nullable

turnstile_site_keystring nullable

kill_switchboolean nullable

web_embed_enabledboolean nullable

booking_form_enabledboolean nullable

zip_routing_enabledboolean nullable

out_of_area_messagestring nullable

intent_mode'chips' | 'text' | 'hidden'

intent_promptstring nullable

intent_optionsstring[] nullable

intent_text_placeholderstring nullable

response_status_textstring nullable

Response

Successful Response

idstring required

organization_idstring required

live_keystring required

test_keystring required

brand_namestring required

brand_logo_urlstring nullable

brand_colorsobject required

launcher_copystring required

launcher_position'bottom-right' | 'bottom-left' required

modal_headlinestring required

modal_subheadstring required

modal_cta_labelstring required

opt_in_copy_overridestring nullable

required_opt_in_text_templatestring nullable

booking_consent_text_templatestring nullable

marketing_consent_text_templatestring nullable

opt_in_copy_addendumstring nullable

tc_urlstring nullable

privacy_urlstring nullable

trust_ratingnumber nullable

trust_review_countinteger nullable

trust_neighbor_countinteger nullable

origin_allowliststring[] required

turnstile_site_keystring nullable

kill_switchboolean required

web_embed_enabledboolean required

booking_form_enabledboolean required

zip_routing_enabledboolean

out_of_area_messagestring nullable

intent_mode'chips' | 'text' | 'hidden'

intent_promptstring

intent_optionsstring[]

intent_text_placeholderstring