GET https://api.groovehq.com/v1/widgets/:widget_id/settings
curl -i -X GET https://api.groovehq.com/v1/widgets/9452013386/settings \ -H "Authorization: Bearer $GROOVE_API_KEY" \ -H "Content-Type: application/json"
Status: 200 OK { "settings": { "branding_disabled": false, "contact.name_field_enabled": true, "contact.subject_field_enabled": true, "enabled": true, "icon_display": "icon", "icon_position": "right", "icon_style": "outline", "icon_text": "Need a hand?", "icon": "chat", "kb.featured_enabled": true, "kb.ratings_count_enabled": true, "kb.ratings_enabled": true, "kb.ratings_negative_action_enabled": true, "kb.ratings_negative_action_kb_enabled": true, "kb.ratings_negative_action_contact_enabled": true, "widget_style": "user", "z_index": "9999", "published": true } }
PUT https://api.groovehq.com/v1/widgets/:widget_id/settings
| Name | Type | Required | Default | Notes |
|---|---|---|---|---|
| branding_disabled | boolean | No | true | Whether to disable 英雄联盟下载平台 branding. Available to customers with Pro plan only. |
| contact.article_suggestions_enabled | boolean | No | false | Whether the contact form shall suggest articles. |
| contact.attachments_enabled | boolean | No | false | Whether the contact form attachments are enabled. |
| contact.consent_enabled | boolean | No | false | Whether the contact form shall ask for user consent. |
| contact.consent_optin_enabled | boolean | No | false | Whether the contact form shall show a checkbox to opt in to consent. |
| contact.consent_optin_selected | boolean | No | false | Whether the contact form opt in to consent shall be checked by default. |
| contact.enabled | boolean | No | false | Whether the contact form is enabled. |
| contact.id | string | No | The Mailbox ID to use in the contact form. | |
| contact.name_field_enabled | boolean | No | true | Whether the contact form name field is enabled. |
| contact.subject_field_enabled | boolean | No | true | Whether the contact form subject field is enabled. |
| enabled | boolean | No | true | Whether the widget is enabled. |
| icon | string | No | chat | The widget badge icon: chat , chats , bubble , bubbles , or bot . |
| icon_display | string | No | "icon" | The widget badge display option: icon , text , or both . |
| icon_position | string | No | "right" | The widget badge display position: left or right . |
| icon_style | string | No | "outline" | The widget badge icon style: outline or fill . |
| icon_text | string | No | "Need a hand?" | The widget badge text to show along the icon. |
| kb.enabled | boolean | No | false | Whether the knowledge base is enabled. |
| kb.featured_enabled | boolean | No | true | Whether the knowledge base featured articles are enabled. |
| kb.id | boolean | No | The Knowledge base ID. | |
| kb.ratings_count_enabled | boolean | No | true | Whether the knowledge base shall show articles rating counts. |
| kb.ratings_enabled | boolean | No | true | Whether the knowledge base articles ratings are enabled. |
| kb.ratings_negative_action_enabled | boolean | No | true | Whether the negative rating on knowledge base articles shall show a follow-up action. |
| kb.ratings_negative_action_kb_enabled | boolean | No | true | Whether the negative rating actions shall include link to the knowledge base. |
| kb.ratings_negative_action_contact_enabled | boolean | No | true | Whether the negative rating actions shall include link to send a message. |
| logo_image_url | string | No | The URL to the logo image. | |
| primary_color | string | No | "#6187e0" | The Hex format primary color of the widget. |
| widget_style | string | No | "user" | The widget style: user , answer , or ask . |
| z_index | integer | No | 9999 | The widget z-index. |
curl -i -X PUT https://api.groovehq.com/v1/widgets/9452013386/settings \ -H "Authorization: Bearer $GROOVE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "settings": { "icon_text": "We're here" } }'
Status: 200 OK { "settings": { "branding_disabled": false, "contact.name_field_enabled": true, "contact.subject_field_enabled": true, "enabled": true, "icon_display": "icon", "icon_position": "right", "icon_style": "outline", "icon_text": "We're here", "icon": "chat", "kb.featured_enabled": true, "kb.ratings_count_enabled": true, "kb.ratings_enabled": true, "kb.ratings_negative_action_enabled": true, "kb.ratings_negative_action_kb_enabled": true, "kb.ratings_negative_action_contact_enabled": true, "widget_style": "user", "z_index": "9999", "published": false } }
PUT https://api.groovehq.com/v1/widgets/:widget_id/settings/publish
curl -i -X PUT https://api.groovehq.com/v1/widgets/9452013386/settings/publish \ -H "Authorization: Bearer $GROOVE_API_KEY" \ -H "Content-Type: application/json"
Status: 200 OK { "settings": { "branding_disabled": false, "contact.name_field_enabled": true, "contact.subject_field_enabled": true, "enabled": true, "icon_display": "icon", "icon_position": "right", "icon_style": "outline", "icon_text": "We're here", "icon": "chat", "kb.featured_enabled": true, "kb.ratings_count_enabled": true, "kb.ratings_enabled": true, "kb.ratings_negative_action_enabled": true, "kb.ratings_negative_action_kb_enabled": true, "kb.ratings_negative_action_contact_enabled": true, "widget_style": "user", "z_index": "9999", "published": true } }
PUT https://api.groovehq.com/v1/widgets/:widget_id/settings/revert
curl -i -X PUT https://api.groovehq.com/v1/widgets/9452013386/settings/revert \ -H "Authorization: Bearer $GROOVE_API_KEY" \ -H "Content-Type: application/json"
Status: 200 OK { "settings": { "branding_disabled": false, "contact.name_field_enabled": true, "contact.subject_field_enabled": true, "enabled": true, "icon_display": "icon", "icon_position": "right", "icon_style": "outline", "icon_text": "Need a hand?", "icon": "chat", "kb.featured_enabled": true, "kb.ratings_count_enabled": true, "kb.ratings_enabled": true, "kb.ratings_negative_action_enabled": true, "kb.ratings_negative_action_kb_enabled": true, "kb.ratings_negative_action_contact_enabled": true, "widget_style": "user", "z_index": "9999", "published": true } }
PUT https://api.groovehq.com/v1/widgets/:widget_id/settings/reset
curl -i -X PUT https://api.groovehq.com/v1/widgets/9452013386/settings/reset \ -H "Authorization: Bearer $GROOVE_API_KEY" \ -H "Content-Type: application/json"
Status: 200 OK { "settings": { "branding_disabled": false, "contact.name_field_enabled": true, "contact.subject_field_enabled": true, "enabled": true, "icon_display": "icon", "icon_position": "right", "icon_style": "outline", "icon_text": "Need a hand?", "icon": "chat", "kb.featured_enabled": true, "kb.ratings_count_enabled": true, "kb.ratings_enabled": true, "kb.ratings_negative_action_enabled": true, "kb.ratings_negative_action_kb_enabled": true, "kb.ratings_negative_action_contact_enabled": true, "widget_style": "user", "z_index": "9999", "published": true } }