Update preferences

PATCH

/notifications/user_preferences/update/v1

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

add_events_by_channelmap from strings to nullable or optional lists of enums or nullOptional

opt_in_to_all_on_channelslist of enums or nullOptional

Allowed values:

opt_out_of_all_on_channelslist of enums or nullOptional

Allowed values:

remove_events_by_channelmap from strings to nullable or optional lists of enums or nullOptional

set_events_by_channelmap from strings to nullable or optional lists of enums or nullOptional

Response

Successful Response

_idstring

created_at_timestampdatetime

last_edited_at_timestampdatetime

schema_versioninteger

user_idstring

Must be a string starting with user_

email_eventslist of enumsOptional

push_eventslist of enumsOptional

sms_eventslist of enumsOptional

Errors

422

User Preferences Update V1request Unprocessable Entity Error

1	import { ChrtClient } from "@chrt-inc/typescript-sdk";
2
3	async function main() {
4	const client = new ChrtClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.notifications.userPreferences.updateV1({});
8	}
9	main();

1	{
2	"_id": "pref_8f14e45fceea167a5a36dedd4bea2543",
3	"created_at_timestamp": "2024-01-15T09:30:00Z",
4	"last_edited_at_timestamp": "2024-01-15T09:30:00Z",
5	"schema_version": 1,
6	"user_id": "user_1234567890",
7	"email_events": [
8	"shipping.order.staged"
9	],
10	"push_events": [
11	"shipping.order.staged"
12	],
13	"sms_events": [
14	"shipping.order.staged"
15	]
16	}