Senders

Create a new sender

post/senders

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/senders
  • Auth: one of:
    • API key in header api-key
    • API key in header partner-key

Request body

namestring required

From Name to use for the sender

emailstring email required

From email to use for the sender. A verification email will be sent to this address.

Example request

{
  "name": "Newsletter",
  "email": "newsletter@mycompany.com",
  "ips": [
    {
      "ip": "123.98.689.7",
      "domain": "mycompany.com",
      "weight": 50
    }
  ]
}

Response

sender created

idinteger required

ID of the Sender created

spfErrorboolean

Status of SPF configuration for the sender (true = SPF not well configured, false = SPF well configured)

dkimErrorboolean

Status of DKIM configuration for the sender (true = DKIM not well configured, false = DKIM well configured)

Example response

{
  "dkimError": false,
  "id": 5,
  "spfError": true
}

Changes

No recorded changes to this operation across all 2 revisions of this API.