Skip to main content

List email preferences

GET 
/auth/email/opt-out

Returns every email category on your account together with your current opt-in status.

Categories are returned as a tree. Each parent category carries a childs array holding the individual notifications it groups, and a category with no children returns an empty childs array. Pass a category's slug to the Update an email preference API to change it.

Categories marked required: true cover critical system, contract, and payment notifications. You cannot opt out of them. A category you have never changed defaults to opted_in: true.

Responses​

Success