identities.setPreferences
Save identity preferences.
Updates or replaces the client preferences JSON object. Supports optimistic locking via the If-Match header.
openemail.identities.setPreferences(
identityId: string,
body: IdentitiesSetPreferencesBody,
options?: IdentitiesSetPreferencesOptions,
): ApiPromise<Prefs>It calls PUT /identities/{identityId}/prefs: Save identity preferences in the API reference.
Example
const prefs = await openemail.identities.setPreferences(identityId, { prefs: {} })Arguments
| Argument | Type | Description |
|---|---|---|
identityId | string | Identity or mailbox identifier. The path's {identityId}. |
body | IdentitiesSetPreferencesBody | The request's body. |
Options
The last argument, options, a IdentitiesSetPreferencesOptions, takes:
| Option | Type | Sent as | Description |
|---|---|---|---|
ifMatch | string | header if-match | Expected current version number for optimistic locking (omit for unconditional update) |
Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
Awaited, it is the API's JSON, Prefs. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
400 | validation_failed — invalid request body |
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | Identity not found or not accessible to this principal |
412 | version_conflict — the preferences were updated by another client |
413 | too_large — preferences payload exceeds size limit (64 KiB) |
503 | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |
A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.
Types
IdentitiesSetPreferencesBody
/** The body of `identities.setPreferences`. */
type IdentitiesSetPreferencesBody = {
prefs: Record<string, unknown>
}It names these types of the API, each on a page of its own: Prefs.