Skip to content

Unset admin ntfn preference.

PUT
/api/web/namespaces/system/user/admin_notifications/unset
curl --request PUT \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/system/user/admin_notifications/unset \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "ntfn_to_unset": "example" }'

Unset admin ntfn preference unsets specific admin notification preference for the user and store it in user settings object. It can be used in email newsletters to allow easy unsubscribing for users.

Examples of this operation.

Media typeapplication/json
Notification unset

Notification to unset.

object
ntfn_to_unset
Ntfn to unset

Ntfn to unset contains notification which should be unset for particular user.

string
<= 1024 characters
Examplegenerated
{
"ntfn_to_unset": "example"
}

A successful response.

Media typeapplication/json
Empty

Empty object definition.

object
Examplegenerated
{}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example