Sender

Senders objects are used to select the From email address for the emails you are sending. Use the resources below to manage and validate your senders.

post

Create a new sender email address or domain

post

/sender

Create a new sender email address or domain. The e-mail address or domain has to be registered and validated before being used to send e-mails. Validation is done via `/sender/{sender_id}/validate`. In order to manage a sender available across multiple API Keys, see the related /metasender resource.

Note: The maximum number of senders and metasenders per user is 100. This includes both validated (Active) and non-validated (Inactive) ones, but does not include Deleted senders / metasenders.

Full API path

https://api.mailjet.com/v3/REST/sender

Body parameters

EmailType

string

Type of emails this sender will send. This is for purely informative purposes - the values do not place any sending restrictions on the sender email or domain.

  • transactional - transactional emails
  • bulk - campaign emails
  • unknown - both

IsDefaultSender

boolean

Indicates whether this is the default sender or not.

Name

string

User-provided name for this sender.

Email

string, required

The email address or domain for this sender.

Responses

Note: You can find all the errors related to API in the error page

Count

integer

Data

array

EmailType

string

Type of emails this sender will send. This is for purely informative purposes - the values do not place any sending restrictions on the sender email or domain.

  • transactional - transactional emails
  • bulk - campaign emails
  • unknown - both

IsDefaultSender

boolean

Indicates whether this is the default sender or not.

Name

string

User-provided name for this sender.

CreatedAt

string

Timestamp indicating when this sender object was created.

DNSID

integer

Unique numeric ID of the DNS domain to which sender belongs. When the sender is inactive, the DNSID will return a -1 value.

Email

string

The email address or domain for this sender.

Filename

string

Filename expected on the domain name webserver. Will only return a value when a sender domain is registered. Used to validate the sender via the /sender/{sender_id}/validate resource.

ID

integer

Unique numeric ID of this sender.

Status

string

The status of this sender.

Possible values:

  • Inactive
  • Active
  • Deleted

Total

integer