APISettings
Update widget settings
Update the widget's appearance and which sections it shows to customers. Requires the admin scope.
PATCH
/settings/widgetcurl -X PATCH "https://productlane.com/api/v2/settings/widget" \
-H "Authorization: Bearer $PRODUCTLANE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enabled": true,
"branding_enabled": true,
"icon_visible": true,
"contact_avatars_enabled": true,
"custom_links_enabled": true,
"custom_links_heading": "string",
"changelog_enabled": true,
"roadmap_enabled": true,
"support_enabled": true,
"help_center_enabled": true,
"ai_chat_enabled": true,
"live_chat_enabled": true,
"guest_chat_enabled": true,
"feedback_enabled": true,
"whats_new_enabled": true
}'Authorization
AuthorizationstringheaderrequiredBearer authentication header of the form
Bearer <token>, where<token>is your auth token.
Body
application/json
enabledbooleanbranding_enabledbooleanicon_visiblebooleancontact_avatars_enabledbooleancustom_links_enabledbooleancustom_links_headingstring | nullchangelog_enabledbooleanroadmap_enabledbooleansupport_enabledbooleanhelp_center_enabledbooleanai_chat_enabledbooleanlive_chat_enabledbooleanguest_chat_enabledbooleanWhen false, only signed-in visitors can start a conversation.
feedback_enabledbooleanwhats_new_enabledboolean
Response
application/json
Successful response
enabledbooleanrequiredwidget_keystringrequireddefault_viewstringrequiredicon_typestringrequiredicon_visiblebooleanrequiredsizestringrequiredbranding_enabledbooleanrequiredcustom_styling_enabledbooleanrequiredcustom_links_enabledbooleanrequiredcustom_links_headingstring | nullrequiredcontact_avatars_enabledbooleanrequiredidentity_verification_enabledbooleanrequiredportal_auth_enabledbooleanrequiredguest_chat_enabledbooleanrequiredsectionsobjectrequiredupdated_atstringrequired
{
"enabled": true,
"widget_key": "string",
"default_view": "string",
"icon_type": "string",
"icon_visible": true,
"size": "string",
"branding_enabled": true,
"custom_styling_enabled": true,
"custom_links_enabled": true,
"custom_links_heading": "string",
"contact_avatars_enabled": true,
"identity_verification_enabled": true,
"portal_auth_enabled": true,
"guest_chat_enabled": true,
"sections": {
"changelog": true,
"roadmap": true,
"support": true,
"help_center": true,
"ai_chat": true,
"live_chat": true,
"feedback": true,
"whats_new": true
},
"updated_at": "string"
}