Email Preferences

Update an email preference

Turns a single email category on or off.

If the slug belongs to a parent category, every child notification grouped under it is updated to the same value. If the slug belongs to a child notification, only that notification changes.

You cannot opt out of a required category. Updating one returns 400 with the message Cannot update a required email category, whether you send opted_in: true or false.

put/auth/email/opt-out/{slug}

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/auth/email/opt-out/{slug}
  • Auth: API key in header api_key

Path parameters

slugstring required

Slug of the email category. Call the List email preferences API to retrieve the slug of an existing category.

Request body

opted_inboolean required

Set to true to receive the notification, or false to turn it off.

Response

Success

messagestring

Human-readable description of the result.

Changes

No recorded changes to this operation across all 1 revision of this API.