Skip to main content

Email & Notifications

Configure mailing lists used for email-based event notification.

See also: Email & Notifications documentation | Full API Reference for interactive testing and complete schemas.

Endpoints

MethodPathDescriptionReference
GET/mailing-listsQuery Mailing ListsAPI Reference →
POST/mailing-listsCreate a Mailing ListAPI Reference →
DELETE/mailing-lists/{xid}Delete a Mailing ListAPI Reference →
GET/mailing-lists/{xid}Get a Mailing ListAPI Reference →
PATCH/mailing-lists/{xid}Partially update a Mailing ListAPI Reference →
PUT/mailing-lists/{xid}Update a Mailing ListAPI Reference →
GET/mailing-lists/exportExport formatted for Configuration Import by supplying an RQL queryAPI Reference →
POST/mailing-lists/validateValidate a Mailing List without saving itAPI Reference →