Notification preferences
/me/notifications/v1The person's email digest cadence and hour, quiet hours, time zone and for-you choice, with the zone in force, the organisation's zone, whether this platform can send email at all and whether it is quiet now. A person's sign-in, or a desktop's device token for one, so a workbench's own quiet hours can follow the platform's. A device with no person behind it is refused.
A device access token from the device-code flow (aioe_at_…). A DPoP-bound token is sent as Authorization: DPoP <token> with a fresh DPoP proof on every request.
In: header
Header Parameters
Mojo Up AI Cloud only, with a person's access token: the id of the organisation the request is for. A person's session is not tied to one organisation, so each request names it. Device tokens already carry their organisation.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/me/notifications/v1"{ "digest": { "cadence": "off", "hour": 8 }, "quietHours": { "enabled": false, "start": "22:00", "end": "07:00" }, "timeZone": "string", "forYou": false}/me/notifications/v1A person's sign-in only, not a device token. The whole set is replaced. The digest goes to the address on the verified sign-in; nothing in the body can set it. Turning the digest on starts its clock now, so the first email goes at the next slot and not at once for a slot already past. Quiet hours hold a phone's buzz, never the record in the inbox.
Authorization
cloudSession Mojo Up AI Cloud: a person's access token from /auth/v1/token. Name the organisation with the X-Aioe-Organisation header where a request acts for one.
In: header
Header Parameters
Mojo Up AI Cloud only, with a person's access token: the id of the organisation the request is for. A person's session is not tied to one organisation, so each request names it. Device tokens already carry their organisation.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/me/notifications/v1" \ -H "Content-Type: application/json" \ -d '{}'{ "digest": { "cadence": "off", "hour": 8 }, "quietHours": { "enabled": false, "start": "22:00", "end": "07:00" }, "timeZone": "string", "forYou": false}