Skip to Content
veriom

Update notification preferences

PUT
/v1/workspaces/{workspace_id}/notification-preferences

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Request Body

application/json
  1. body
audit_completed*Audit Completed
audit_failed*Audit Failed
audit_stream_paused?|

Email this owner or admin when an audit stream pauses itself. Omit it to keep the current choice.

browser_enabled*Browser Enabled
continuous_audit_attention*Continuous Audit Attention
email_enabled*Email Enabled
export_completed*Export Completed
in_app_enabled*In App Enabled
report_ready*Report Ready

Response Body

Successful Response

application/json
  1. response
audit_completed*Audit Completed
audit_failed*Audit Failed
audit_stream_paused*Audit Stream Paused

Email this owner or admin when an audit stream pauses itself.

browser_enabled*Browser Enabled
continuous_audit_attention*Continuous Audit Attention
email_enabled*Email Enabled
export_completed*Export Completed
in_app_enabled*In App Enabled
report_ready*Report Ready
updated_at?|null
Example Request
curl -X PUT 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/notification-preferences' \  -H 'Content-Type: application/json' \  -d '{  "audit_completed": true,  "audit_failed": true,  "browser_enabled": true,  "continuous_audit_attention": true,  "email_enabled": true,  "export_completed": true,  "in_app_enabled": true,  "report_ready": true}'
Example Response
{  "audit_completed": true,  "audit_failed": true,  "audit_stream_paused": true,  "browser_enabled": true,  "continuous_audit_attention": true,  "email_enabled": true,  "export_completed": true,  "in_app_enabled": true,  "report_ready": true,  "updated_at": "2019-08-24T14:15:22Z"}