Notification Preferences

Get alert notification preferences of a user

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

Responses
200

the response

application/json
get
/users/{user-id}/notification-preferences/alerts
200

the response

Create an alert notification preference

post
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

Body
methodstring · enumOptionalPossible values:
contactone ofOptional
or
delayMinintegerOptional
typestring · enumOptionalPossible values:
Responses
post
/users/{user-id}/notification-preferences/alerts
201

the response

Get specific notification preferences alert

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
200

the response

application/json
get
/users/{user-id}/notification-preferences/alerts/{id}
200

the response

Update a user's alert notification preference

put
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Body
methodstring · enumOptionalPossible values:
contactone ofOptional
or
delayMinintegerOptional
typestring · enumOptionalPossible values:
Responses
200

the response

application/json
put
/users/{user-id}/notification-preferences/alerts/{id}
200

the response

Delete the user's specified notification preferences alert

delete
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
delete
/users/{user-id}/notification-preferences/alerts/{id}
204

if deletion was successful

No content

Get duty notification preferences of a user

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

Responses
200

the response

application/json
get
/users/{user-id}/notification-preferences/duties
200

the response

Create a duty notification preference

post
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

Body
beforeMininteger · enumOptionalPossible values:
contactone ofOptional
or
methodstring · enumOptionalPossible values:
typestring · enumOptionalPossible values:
Responses
post
/users/{user-id}/notification-preferences/duties
201

the response

Get specific notification preferences duty

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
200

the response

application/json
get
/users/{user-id}/notification-preferences/duties/{id}
200

the response

Update a user's duty notification preference

put
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Body
beforeMininteger · enumOptionalPossible values:
contactone ofOptional
or
methodstring · enumOptionalPossible values:
typestring · enumOptionalPossible values:
Responses
200

the response

application/json
put
/users/{user-id}/notification-preferences/duties/{id}
200

the response

Delete the user's specified notification preferences duty

delete
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
delete
/users/{user-id}/notification-preferences/duties/{id}
204

if deletion was successful

No content

Get update notification preferences of a user

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

Responses
200

the response

application/json
get
/users/{user-id}/notification-preferences/updates
200

the response

Create an update notification preference

post
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

Body
contactone ofOptional
or
methodstring · enumOptionalPossible values:
typestring · enumOptionalPossible values:
Responses
post
/users/{user-id}/notification-preferences/updates
201

the response

Get specific notification preferences update

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
200

the response

application/json
get
/users/{user-id}/notification-preferences/updates/{id}
200

the response

Update a user's update notification preference

put
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Body
contactone ofOptional
or
methodstring · enumOptionalPossible values:
typestring · enumOptionalPossible values:
Responses
200

the response

application/json
put
/users/{user-id}/notification-preferences/updates/{id}
200

the response

Delete the user's specified notification preferences update

delete
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
delete
/users/{user-id}/notification-preferences/updates/{id}
204

if deletion was successful

No content

Get subscription notification preferences of a user

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

Responses
200

the response

application/json
get
/users/{user-id}/notification-preferences/subscriptions
200

the response

Create a subscription notification preference

post
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

Body
contactone ofOptional
or
methodstring · enumOptionalPossible values:
Responses
post
/users/{user-id}/notification-preferences/subscriptions
201

the response

Get specific notification preferences subscription

get
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
200

the response

application/json
get
/users/{user-id}/notification-preferences/subscriptions/{id}
200

the response

Update a user's subscription notification preference

put
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Body
contactone ofOptional
or
methodstring · enumOptionalPossible values:
Responses
200

the response

application/json
put
/users/{user-id}/notification-preferences/subscriptions/{id}
200

the response

Delete the user's specified notification preferences subscription

delete
Authorizations
AuthorizationstringRequired

The Bearer API key of your user more info.

Path parameters
user-idstringRequired

numeric user id

idnumberRequired

entity ID

Responses
delete
/users/{user-id}/notification-preferences/subscriptions/{id}
204

if deletion was successful

No content

Last updated

Was this helpful?