Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

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-expiration
string

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.

Path Parameters

user_id
string
required

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

Query Parameters

tenant_id
string | null

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

Body

application/json
topics
UsersBulkTopicPreferenceUpdate · object[]
required

The topics to create or update. Between 1 and 50 topics may be provided in a single request.

Required array length: 1 - 50 elements

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.

items
UsersBulkPreferenceTopic · object[]
required

The topics that were successfully created or updated.

errors
UsersBulkPreferenceError · object[]
required

The topics that could not be applied, each with a reason.