# Settings and configurations API

> Chat settings, notifications, search filters, shortcuts, snippets, satisfaction surveys, snoozes and user settings.

Source: https://developer.kustomer.com/api/settings-and-configurations

Server: `https://api.kustomerapp.com/v1` · 55 operations

This category describes related to settings and configurations for chat, notifications, search filters, user settings, snippets, and snoozes in Kustomer.

## Chat Settings

Chat settings control how the Kustomer chat widget looks and behaves on your website and in your apps, such as the team name and greeting customers see, what happens outside business hours, and whether customers can see past conversations.

- [Get chat settings](https://developer.kustomer.com/api/settings-and-configurations/get-chat-settings.md): `GET /v1/chat/settings`
- [Set chat settings](https://developer.kustomer.com/api/settings-and-configurations/set-chat-settings.md): `PATCH /v1/chat/settings`

## Notifications (Logs)

Notifications are the alerts Kustomer sends a user about activity they care about, such as a conversation being assigned to them or a teammate mentioning them in a note. Each user chooses which events notify them in the app and by email, and admins choose who receives org-wide alerts about problems such as a disconnected channel.

- [Get notifications logs settings](https://developer.kustomer.com/api/settings-and-configurations/get-notifications-logs-settings.md): `GET /v1/notifications/logs/settings`
- [Update notifications logs settings](https://developer.kustomer.com/api/settings-and-configurations/update-notifications-logs-settings.md): `PUT /v1/notifications/logs/settings`

## Notifications (Settings)

Notifications are the alerts Kustomer sends a user about activity they care about, such as a conversation being assigned to them or a teammate mentioning them in a note. Each user chooses which events notify them in the app and by email, and admins choose who receives org-wide alerts about problems such as a disconnected channel.

- [Get notification settings for current user](https://developer.kustomer.com/api/settings-and-configurations/get-notification-settings-for-current-user.md): `GET /v1/notifications/users/current/settings`
- [Update notification settings for current user](https://developer.kustomer.com/api/settings-and-configurations/update-notification-settings-for-current-user.md): `PUT /v1/notifications/users/current/settings`

## Notifications

Notifications are the alerts Kustomer sends a user about activity they care about, such as a conversation being assigned to them or a teammate mentioning them in a note. Each user chooses which events notify them in the app and by email, and admins choose who receives org-wide alerts about problems such as a disconnected channel.

- [Get notifications](https://developer.kustomer.com/api/settings-and-configurations/get-notifications.md): `GET /v1/notifications`
- [Update notifications](https://developer.kustomer.com/api/settings-and-configurations/update-notifications.md): `PUT /v1/notifications`
- [Delete notifications](https://developer.kustomer.com/api/settings-and-configurations/delete-notifications.md): `DELETE /v1/notifications`

## Search Filters

A saved search is a named, reusable search query, such as "Open VIP conversations" or "Unassigned email", that appears in the agent desktop's sidebar so agents can open the matching list in one click. Admins arrange saved searches into folders, and each user can pin up to five favorites.

- [Get all searches](https://developer.kustomer.com/api/settings-and-configurations/get-all-searches.md): `GET /v1/customers/searches`
- [Create Saved Search](https://developer.kustomer.com/api/settings-and-configurations/create-saved-search.md): `POST /v1/customers/searches`
- [Get saved search by ID](https://developer.kustomer.com/api/settings-and-configurations/get-saved-search-by-id.md): `GET /v1/customers/searches/{id}`
- [Update search by ID](https://developer.kustomer.com/api/settings-and-configurations/update-search-by-id.md): `PUT /v1/customers/searches/{id}`
- [Delete search by ID](https://developer.kustomer.com/api/settings-and-configurations/delete-search-by-id.md): `DELETE /v1/customers/searches/{id}`
- [Get search positions](https://developer.kustomer.com/api/settings-and-configurations/get-search-positions.md): `GET /v1/customers/searches/positions`
- [Update search positions](https://developer.kustomer.com/api/settings-and-configurations/update-search-positions.md): `PUT /v1/customers/searches/positions`
- [Get schema for searches](https://developer.kustomer.com/api/settings-and-configurations/get-schema-for-searches.md): `GET /v1/customers/searches/schema`

## Search Filters (Folders)

A saved search is a named, reusable search query, such as "Open VIP conversations" or "Unassigned email", that appears in the agent desktop's sidebar so agents can open the matching list in one click. Admins arrange saved searches into folders, and each user can pin up to five favorites.

- [Create search folder](https://developer.kustomer.com/api/settings-and-configurations/create-search-folder.md): `POST /v1/customers/searches/folders`
- [Update search folder by ID](https://developer.kustomer.com/api/settings-and-configurations/update-search-folder-by-id.md): `PUT /v1/customers/searches/folders/{id}`
- [Delete search folder by ID](https://developer.kustomer.com/api/settings-and-configurations/delete-search-folder-by-id.md): `DELETE /v1/customers/searches/folders/{id}`

## Search Filters (Pinned)

A saved search is a named, reusable search query, such as "Open VIP conversations" or "Unassigned email", that appears in the agent desktop's sidebar so agents can open the matching list in one click. Admins arrange saved searches into folders, and each user can pin up to five favorites.

- [Get all pinned searches](https://developer.kustomer.com/api/settings-and-configurations/get-all-pinned-searches.md): `GET /v1/customers/searches/pinned`
- [Pin search](https://developer.kustomer.com/api/settings-and-configurations/pin-search.md): `POST /v1/customers/searches/pinned`
- [Delete pinned search by ID](https://developer.kustomer.com/api/settings-and-configurations/delete-pinned-search-by-id.md): `DELETE /v1/customers/searches/pinned/{id}`

## Settings

Settings are named configuration values that change how Kustomer and installed apps behave. Org settings apply to everyone in the org, such as satisfaction survey timing or an app's API key, while user settings are personal preferences, such as what the send button does for one agent.

- [Get settings](https://developer.kustomer.com/api/settings-and-configurations/get-settings.md): `GET /v1/settings`
- [Get user settings](https://developer.kustomer.com/api/settings-and-configurations/get-user-settings.md): `GET /v1/users/{id}/settings`
- [Get user settings for current user](https://developer.kustomer.com/api/settings-and-configurations/get-user-settings-for-current-user.md): `GET /v1/users/current/settings`
- [Get a setting](https://developer.kustomer.com/api/settings-and-configurations/get-a-setting.md): `GET /v1/settings/{app}/{category}/{name}`
- [Update a setting](https://developer.kustomer.com/api/settings-and-configurations/update-a-setting.md): `PUT /v1/settings/{app}/{category}/{name}`

## Settings (Specific User)

Settings are named configuration values that change how Kustomer and installed apps behave. Org settings apply to everyone in the org, such as satisfaction survey timing or an app's API key, while user settings are personal preferences, such as what the send button does for one agent.

- [Get specific user setting](https://developer.kustomer.com/api/settings-and-configurations/get-specific-user-setting.md): `GET /v1/users/{id}/settings/{app}/{category}/{name}`
- [Update specific user setting](https://developer.kustomer.com/api/settings-and-configurations/update-specific-user-setting.md): `PUT /v1/users/{id}/settings/{app}/{category}/{name}`
- [Get specific user setting for current user](https://developer.kustomer.com/api/settings-and-configurations/get-specific-user-setting-for-current-user.md): `GET /v1/users/current/settings/{app}/{category}/{name}`
- [Update specific user setting for current user](https://developer.kustomer.com/api/settings-and-configurations/update-specific-user-setting-for-current-user.md): `PUT /v1/users/current/settings/{app}/{category}/{name}`

## Shortcuts (Categories)

A shortcut is a saved reply that agents insert into a conversation instead of typing the same answer again. Its text can include placeholders such as the customer's first name, and it can also update the conversation, for example by adding a tag or marking it done.

- [Get shortcut categories](https://developer.kustomer.com/api/settings-and-configurations/get-shortcut-categories.md): `GET /v1/shortcuts/categories`
- [Create a shortcut category](https://developer.kustomer.com/api/settings-and-configurations/create-a-shortcut-category.md): `POST /v1/shortcuts/categories`
- [Get a shortcut category](https://developer.kustomer.com/api/settings-and-configurations/get-a-shortcut-category.md): `GET /v1/shortcuts/categories/{id}`
- [Update a shortcut category](https://developer.kustomer.com/api/settings-and-configurations/update-a-shortcut-category.md): `PUT /v1/shortcuts/categories/{id}`
- [Delete a shortcut category](https://developer.kustomer.com/api/settings-and-configurations/delete-a-shortcut-category.md): `DELETE /v1/shortcuts/categories/{id}`

## Shortcuts

A shortcut is a saved reply that agents insert into a conversation instead of typing the same answer again. Its text can include placeholders such as the customer's first name, and it can also update the conversation, for example by adding a tag or marking it done.

- [Get all shortcuts](https://developer.kustomer.com/api/settings-and-configurations/get-all-shortcuts.md): `GET /v1/shortcuts`
- [Create a shortcut](https://developer.kustomer.com/api/settings-and-configurations/create-a-shortcut.md): `POST /v1/shortcuts`
- [Get a shortcut](https://developer.kustomer.com/api/settings-and-configurations/get-a-shortcut.md): `GET /v1/shortcuts/{id}`
- [Update a shortcut](https://developer.kustomer.com/api/settings-and-configurations/update-a-shortcut.md): `PUT /v1/shortcuts/{id}`
- [Delete a shortcut](https://developer.kustomer.com/api/settings-and-configurations/delete-a-shortcut.md): `DELETE /v1/shortcuts/{id}`

## Snippets

A snippet is a piece of text stored once with a translation for each language, such as a greeting or a policy sentence. Shortcuts, chat settings and other customer-facing text reference it by key, and Kustomer fills in the right language when the text is shown.

- [Get snippets](https://developer.kustomer.com/api/settings-and-configurations/get-snippets.md): `GET /v1/snippets`
- [Create snippet](https://developer.kustomer.com/api/settings-and-configurations/create-snippet.md): `POST /v1/snippets`
- [Get snippet by ID or key](https://developer.kustomer.com/api/settings-and-configurations/get-snippet-by-id-or-key.md): `GET /v1/snippets/{id}`
- [Update snippet](https://developer.kustomer.com/api/settings-and-configurations/update-snippet.md): `PUT /v1/snippets/{id}`
- [Patch snippet](https://developer.kustomer.com/api/settings-and-configurations/patch-snippet.md): `PATCH /v1/snippets/{id}`

## Satisfaction Surveys

Satisfaction surveys (CSAT) ask customers to rate their experience after a conversation. A survey defines the question, rating scale, channel and audience; each time one is sent, Kustomer creates a satisfaction response that tracks delivery and stores the customer's rating and comments.

- [Create a satisfaction survey](https://developer.kustomer.com/api/settings-and-configurations/create-a-satisfaction-survey.md): `POST /v1/satisfaction`
- [Update a satisfaction survey](https://developer.kustomer.com/api/settings-and-configurations/update-a-satisfaction-survey.md): `PUT /v1/satisfaction/{id}`
- [Update satisfaction survey order](https://developer.kustomer.com/api/settings-and-configurations/update-satisfaction-survey-order.md): `PUT /v1/satisfaction/order`

## Snoozes

Snooze options are the preset choices, such as "2 Hours" or "Tomorrow", that agents pick from when they snooze a conversation or custom object. Each option says how to work out the wake-up time; snoozing hides the item until then and reopens it when the time comes.

- [Get all snoozes](https://developer.kustomer.com/api/settings-and-configurations/get-all-snoozes.md): `GET /v1/snoozes`
- [Create a snooze](https://developer.kustomer.com/api/settings-and-configurations/create-a-snooze.md): `POST /v1/snoozes`
- [Get snooze by ID](https://developer.kustomer.com/api/settings-and-configurations/get-snooze-by-id.md): `GET /v1/snoozes/{id}`
- [Update snooze by ID](https://developer.kustomer.com/api/settings-and-configurations/update-snooze-by-id.md): `PUT /v1/snoozes/{id}`
- [Delete snooze](https://developer.kustomer.com/api/settings-and-configurations/delete-snooze.md): `DELETE /v1/snoozes/{id}`