Create a new email sender
POST /internal/v2/{bucket}/email_senders
POST
/internal/v2/{bucket}/email_senders
This API call is currently in alpha. May change without prior notice.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” bucket
required
The bucket (client) name
string
Example
exampleRequest Body required
Section titled “Request Body required ”Email sender creation packet
object
uid
Unique identifier for the email sender
string
email
required
Email address of the sender
string
display_name
required
Display name of the email sender
string
products
required
List of products the sender is associated with
Array<string>
allow_for_all_users
required
Whether the email sender is allowed for all users
boolean
specific_user_list
required
List of specific user URIs
Array<string>
Responses
Section titled “ Responses ”Email sender successfully created
object
uid
Unique identifier for the email sender
string
email
required
Email address of the sender
string
display_name
required
Display name of the email sender
string
products
required
List of products the sender is associated with
Array<string>
allow_for_all_users
required
Whether the email sender is allowed for all users
boolean
specific_user_list
required
List of specific user URIs
Array<string>
Email sender already exists