Create a new email notification configuration

This endpoint enables you to create an email notification, by selecting a type of notification that should trigger the sending of this email and specify who the email should be sent to, when the conditions are met.

At least one recipient should be specified.

There is one event type which can trigger an email to be sent:

CASE_ASSIGNED

Sends an email to the assignee, whenever a new case is assigned to that user. If that user is configured in the list of recipients and the person assigning the email is not the same user (so only sending an email notification when someone else assigns a case to this user).

Example:

Hi Sophie,

A case has been assigned to you by Julian
Type: Customer Onboarding
Created at: February 10, 2025 at 10:00am
Stage: In Review
Assignee: Sophie
Note: Assigned to you because you are specialized on these scenarios
Click here to view this case

Please contact [email protected] if you have any questions.

You need the "Create and update email notification configurations" permission to use this endpoint.

Body Params
enabled_for
object
required

Lists of user and role identifiers the email will be sent to

string | null
enum

The event type that the user wants to listen to

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json