Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

Channels to change by type, and for a member their timezone. The same request sets a member's choices and an organization's defaults.

channels
object

The channel by type: in_app, email, digest or off. Null follows the default again; a type left out stays as it is.

Example:
timezone
string

An IANA timezone, such as America/Denver. The daily digest arrives at 7 in the morning there. Ignored for organization defaults.

Example:

"America/Denver"

Response

PreferencesResource

data
PreferencesResource · object
required