Skip to content
WorkRoad home
REST API

Resume notification email

POST
/settings/notifications/resume-email

Turns notification email back on after it was suppressed because a message bounced or was reported as spam. Fix the address first, or the next email suppresses it again.

Required scopes: settings:update

Authorization

headerAuthorizationBearer <token>

Header Parameters

Idempotency-Key?string

A client-generated key (1 to 255 visible ASCII characters) that makes this POST safe to retry. A retry with the same key and body replays the original response; the same key with a different body returns 409 idempotency_conflict. Stored for 24 hours.

Match^[\x21-\x7E]{1,255}$
Length1 <= length <= 255

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X POST 'https://workroad.app/api/v1/settings/notifications/resume-email' \  -H 'Authorization: Bearer $WORKROAD_API_KEY'
Example Response
{  "data": {    "quietHoursEnabled": true,    "quietStart": "22:00",    "quietEnd": "07:00",    "pushShowContent": false,    "calendarAlarms": false,    "digestFrequency": "WEEKLY",    "digestTime": "07:30",    "digestWeekday": 1,    "emailSuppressedAt": null,    "emailSuppressedReason": null,    "emailVerified": true,    "kinds": [      {        "kind": "TASK_DUE",        "inApp": true,        "email": false,        "push": true,        "leadMinutes": 60,        "leadDays": [          1        ],        "localTime": "18:00"      },      {        "kind": "EXAM_SOON",        "inApp": true,        "email": true,        "push": true,        "leadMinutes": null,        "leadDays": [          3,          1        ],        "localTime": "18:00"      }    ]  }}

Replace the dashboard layout PUT

Sets which cards the dashboard shows, in order, and their sizes.

Update one notification kind PATCH

Turns a kind's bell, email or push on or off, or changes when it is sent.