> This page is for version Dev.
> For other versions, use one of these documentation indexes:
> - Prod (default): https://docs.chrt.com/prod/llms.txt
> - Staging: https://docs.chrt.com/staging/llms.txt
> - Dev: https://docs.chrt.com/dev/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.chrt.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.chrt.com/_mcp/server.

# Update preferences

PATCH https://api.dev.chrt.com/notifications/user_preferences/update/v1
Content-Type: application/json

Updates notification preferences with explicit events, opt-in, or opt-out operations. | (UserNotificationPreferencesUpdateRequest) -> (NotificationUserPreferences1)

Reference: https://docs.chrt.com/api-reference/api-reference/notifications/user-preferences/update-v-1

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.dev.chrt.com` (Development, default)
- `https://localhost:8000` (Local)
- `https://api.staging.chrt.com` (Staging)
- `https://api.chrt.com` (Production)

## Request

### Body (application/json)

This endpoint expects an UserNotificationPreferencesUpdateRequest.

- `add_events_by_channel` (map from string to list of enum, optional, nullable)
  - Allowed values: `shipping.order.staged`, `shipping.order.completed`, `shipping.order.cancelled`, `shipping.task_group.driver_assigned`, `shipping.task_group.message`, `shipping.task_group.tasks_ordering_updated`, `shipping.task_group.flight_info_updated`, `shipping.task_group.tracking_sharing_updated`, `shipping.cargo.tracking_sharing_updated`, `shipping.task.executor_org_note_added`, `listing.listing.driver_invited_to_bid`, `listing.bid_thread.action_added`, `operations.order.operator_assigned`, `operations.order.department_assigned`, `operations.order_internal_messages.message`, `operations.order_internal_messages.file_added`, `billing.invoice.approved`, `tracking.session.geofence_entered`, `shipping_integration.order.staged`, `shipping_integration.order.in_progress`, `shipping_integration.order.completed`, `shipping_integration.order.exception`, `shipping_integration.order.cancelled`
- `opt_in_to_all_on_channels` (list of enum, optional, nullable)
  - Allowed values: `email`, `sms`, `push`
- `opt_out_of_all_on_channels` (list of enum, optional, nullable)
  - Allowed values: `email`, `sms`, `push`
- `remove_events_by_channel` (map from string to list of enum, optional, nullable)
  - Allowed values: `shipping.order.staged`, `shipping.order.completed`, `shipping.order.cancelled`, `shipping.task_group.driver_assigned`, `shipping.task_group.message`, `shipping.task_group.tasks_ordering_updated`, `shipping.task_group.flight_info_updated`, `shipping.task_group.tracking_sharing_updated`, `shipping.cargo.tracking_sharing_updated`, `shipping.task.executor_org_note_added`, `listing.listing.driver_invited_to_bid`, `listing.bid_thread.action_added`, `operations.order.operator_assigned`, `operations.order.department_assigned`, `operations.order_internal_messages.message`, `operations.order_internal_messages.file_added`, `billing.invoice.approved`, `tracking.session.geofence_entered`, `shipping_integration.order.staged`, `shipping_integration.order.in_progress`, `shipping_integration.order.completed`, `shipping_integration.order.exception`, `shipping_integration.order.cancelled`
- `set_events_by_channel` (map from string to list of enum, optional, nullable)
  - Allowed values: `shipping.order.staged`, `shipping.order.completed`, `shipping.order.cancelled`, `shipping.task_group.driver_assigned`, `shipping.task_group.message`, `shipping.task_group.tasks_ordering_updated`, `shipping.task_group.flight_info_updated`, `shipping.task_group.tracking_sharing_updated`, `shipping.cargo.tracking_sharing_updated`, `shipping.task.executor_org_note_added`, `listing.listing.driver_invited_to_bid`, `listing.bid_thread.action_added`, `operations.order.operator_assigned`, `operations.order.department_assigned`, `operations.order_internal_messages.message`, `operations.order_internal_messages.file_added`, `billing.invoice.approved`, `tracking.session.geofence_entered`, `shipping_integration.order.staged`, `shipping_integration.order.in_progress`, `shipping_integration.order.completed`, `shipping_integration.order.exception`, `shipping_integration.order.cancelled`

## Response

### 200

Successful Response

- `_id` (string, required)
- `created_at_timestamp` (string, required)
- `last_edited_at_timestamp` (string, required)
- `schema_version` (integer, required)
- `user_id` (string, required) — Must be a string starting with `user_`
- `email_events` (list of enum, optional)
  - Allowed values: `shipping.order.staged`, `shipping.order.completed`, `shipping.order.cancelled`, `shipping.task_group.driver_assigned`, `shipping.task_group.message`, `shipping.task_group.tasks_ordering_updated`, `shipping.task_group.flight_info_updated`, `shipping.task_group.tracking_sharing_updated`, `shipping.cargo.tracking_sharing_updated`, `shipping.task.executor_org_note_added`, `listing.listing.driver_invited_to_bid`, `listing.bid_thread.action_added`, `operations.order.operator_assigned`, `operations.order.department_assigned`, `operations.order_internal_messages.message`, `operations.order_internal_messages.file_added`, `billing.invoice.approved`, `tracking.session.geofence_entered`, `shipping_integration.order.staged`, `shipping_integration.order.in_progress`, `shipping_integration.order.completed`, `shipping_integration.order.exception`, `shipping_integration.order.cancelled`
- `push_events` (list of enum, optional)
  - Allowed values: `shipping.order.staged`, `shipping.order.completed`, `shipping.order.cancelled`, `shipping.task_group.driver_assigned`, `shipping.task_group.message`, `shipping.task_group.tasks_ordering_updated`, `shipping.task_group.flight_info_updated`, `shipping.task_group.tracking_sharing_updated`, `shipping.cargo.tracking_sharing_updated`, `shipping.task.executor_org_note_added`, `listing.listing.driver_invited_to_bid`, `listing.bid_thread.action_added`, `operations.order.operator_assigned`, `operations.order.department_assigned`, `operations.order_internal_messages.message`, `operations.order_internal_messages.file_added`, `billing.invoice.approved`, `tracking.session.geofence_entered`, `shipping_integration.order.staged`, `shipping_integration.order.in_progress`, `shipping_integration.order.completed`, `shipping_integration.order.exception`, `shipping_integration.order.cancelled`
- `sms_events` (list of enum, optional)
  - Allowed values: `shipping.order.staged`, `shipping.order.completed`, `shipping.order.cancelled`, `shipping.task_group.driver_assigned`, `shipping.task_group.message`, `shipping.task_group.tasks_ordering_updated`, `shipping.task_group.flight_info_updated`, `shipping.task_group.tracking_sharing_updated`, `shipping.cargo.tracking_sharing_updated`, `shipping.task.executor_org_note_added`, `listing.listing.driver_invited_to_bid`, `listing.bid_thread.action_added`, `operations.order.operator_assigned`, `operations.order.department_assigned`, `operations.order_internal_messages.message`, `operations.order_internal_messages.file_added`, `billing.invoice.approved`, `tracking.session.geofence_entered`, `shipping_integration.order.staged`, `shipping_integration.order.in_progress`, `shipping_integration.order.completed`, `shipping_integration.order.exception`, `shipping_integration.order.cancelled`

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

## Types

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)
- `ctx` (ValidationErrorCtx, optional)
- `input` (any, optional)

### ValidationErrorLocItems

- string
- integer

### ValidationErrorCtx

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "_id": "string",
  "created_at_timestamp": "2024-01-15T09:30:00Z",
  "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
  "schema_version": 1,
  "user_id": "string",
  "email_events": [
    "shipping.order.staged"
  ],
  "push_events": [
    "shipping.order.staged"
  ],
  "sms_events": [
    "shipping.order.staged"
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.dev.chrt.com/notifications/user_preferences/update/v1"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.dev.chrt.com/notifications/user_preferences/update/v1';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dev.chrt.com/notifications/user_preferences/update/v1"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.dev.chrt.com/notifications/user_preferences/update/v1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.dev.chrt.com/notifications/user_preferences/update/v1")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.dev.chrt.com/notifications/user_preferences/update/v1', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.dev.chrt.com/notifications/user_preferences/update/v1");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.dev.chrt.com/notifications/user_preferences/update/v1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```