Skip to main content
PATCH
Update notification settings

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Body

application/json
notification_settings
object
required

The complete set of flags to turn on.

Response

Success

Which notification events this user receives by email and by push, for one account.

id
integer

The numeric ID of the settings record.

user_id
integer

The user the settings belong to.

account_id
integer

The account they apply to. A user in several accounts has one record per account.

all_email_flags
string[]

Every email flag that exists — the menu of what you may select.

selected_email_flags
string[]

The email flags currently on.

all_push_flags
string[]

Every push flag that exists.

selected_push_flags
string[]

The push flags currently on.