Retrieve notice preferences

Reads the person's notice language and, per category, which channels deliver its notices from the organization.

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Notices

Something wrong or missing on this page? Tell us by email or on Discord.

Examples

curl -X GET "https://api.voidhash.com/api/v1/organizations/org_w5xk2e7q0lzv3n8b1c4d6f9g/notice-preferences" \  -H "Authorization: Bearer vh_sk_..."

{  "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": true    }  ]}

{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}

{  "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."  }}

Retrieve notice preferences

Errors

More in Notices

Retrieve notice preferences

Errors

More in Notices

Authorization

Path parameters

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Retrieve notice preferences

Retrieve notice preferences

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`