Update preferences

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.

set_events_by_channelmap from strings to lists of enums or nullOptional

add_events_by_channelmap from strings to lists of enums or nullOptional

remove_events_by_channelmap from strings to 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:

Response

Successful Response

schema_versioninteger

user_idstring

Must be a string starting with user_

created_at_timestampstringformat: "date-time"

last_edited_at_timestampstringformat: "date-time"

_idstring

email_eventslist of enums or null

push_eventslist of enums or null

sms_eventslist of enums or null

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

1	{
2	"schema_version": 1,
3	"user_id": "user_987654321",
4	"created_at_timestamp": "2024-01-15T09:30:00Z",
5	"last_edited_at_timestamp": "2024-01-15T09:30:00Z",
6	"_id": "507f1f77bcf86cd799439011",
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	}

Authentication

Request

Response

Errors