Update notice preferences
Changes which channels deliver each category of the organization's notices, and the person's notice language, which applies in every organization; returns the preferences.
Billing, legal and security notices cannot be muted.
Guide: Notices
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The organization's id, org_....
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
The language of the person's notices, in every organization.
The categories whose channels change in this organization; categories left out keep theirs.
Examples
curl -X PATCH "https://api.voidhash.com/api/v1/organizations/org_w5xk2e7q0lzv3n8b1c4d6f9g/notice-preferences" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "categories": [ { "category": "product", "isEmailEnabled": false } ] }'{ "organizationId": "org_w5xk2e7q0lzv3n8b1c4d6f9g", "locale": "en", "categories": [ { "category": "billing", "isMandatory": true, "isInboxEnabled": true, "isEmailEnabled": true }, { "category": "legal", "isMandatory": true, "isInboxEnabled": true, "isEmailEnabled": true }, { "category": "security", "isMandatory": true, "isInboxEnabled": true, "isEmailEnabled": true }, { "category": "account", "isMandatory": false, "isInboxEnabled": true, "isEmailEnabled": true }, { "category": "integrations", "isMandatory": false, "isInboxEnabled": true, "isEmailEnabled": true }, { "category": "product", "isMandatory": false, "isInboxEnabled": true, "isEmailEnabled": false } ]}{ "error": { "type": "invalid_request", "code": "notice_category_mandatory", "message": "billing notices cannot be turned off.", "param": "categories" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "organization_not_found", "message": "There is no organization org_w5xk2e7q0lzv3n8b1c4d6f9g, or this credential cannot use it.", "param": "organizationId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | notice_category_mandatory | When turning one off. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Notices
- List notices
GET - Count unread notices
GET - Mark notices read
POST - Archive notices
POST - Unarchive notices
POST - Retrieve notice preferences
GET
Something wrong or missing on this page? Tell us by email or on Discord.