v53

OpenAPI 3.0.1raw.githubusercontent.com2026-07-31147343479.6 KB
User Preferences

Update user preferences in bulk

Adds or updates a user's preferences for several subscription topics at once. Topics you leave out keep whatever they were set to before.

post/users/{user_id}/preferences

Path parameters

user_idstring required

A unique identifier associated with the user whose preferences you wish to update.

Query parameters

tenant_idstring nullable

Update the preferences of a user for this specific tenant context.

Headers

Idempotency-Keystring

A unique key that makes this request idempotent. If Courier receives another request with the same Idempotency-Key, it returns the stored response from the first request without performing the operation again (including the original status code and any error). Use it to safely retry POST requests after network failures without risking duplicate sends. The key is scoped to this endpoint.

x-idempotency-expirationstring

How long the idempotency key remains valid, as a Unix epoch timestamp in seconds or an ISO 8601 date string. Only applies when Idempotency-Key is provided. If omitted, the key is retained for 25 hours; the maximum is 1 year.

Request body

Response

The bulk update was applied. items contains the resulting topic overrides that were created or updated, and errors lists any topics that could not be applied, each with a reason.