Skip to content

Get email sender by UID

GET
/internal/v2/{bucket}/email_sender/{uid}

This API call is currently in alpha. May change without prior notice.

bucket
required

The bucket (client) name

string
Example
example
uid
required
string

Unique identifier for the email sender

Details of the email sender

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 not found