API Reference

Update notification preferences

patch
https://api.cardda.com/v1/company_memberships/notification_preferences

Updates the authenticated user's notification preferences for their
membership in the current company. The preferences object maps each
known notification type to a channel map. Valid channels are in_app and
email; valid modes are immediate, daily, weekly, disabled. Unknown
types, channels or modes return 422.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
preferences
object
required

Map of notification type to { in_app, email } mode map. Each
mode is one of immediate, daily, weekly, disabled.

Headers
uuid
required

UUID of the company on whose behalf the request is made. Required for every Organization endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized

404

Membership not found

Updated 4 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago

Did this page help you?