Sender creation and management

You can check out the API public reference endpoints for senders at API Reference > Senders. We will talk through the endpoints one by one starting from Create a new sender.

1. Create a new sender

You can use the endpoint https://api.brevo.com/v3/senders for this API call with the calling method POST. The cURL request for this endpoint will be like this:

1
curl --request POST \
2
     --url https://api.brevo.com/v3/senders \
3
     --header 'accept: application/json' \
4
     --header 'api-key: ' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
     "ips": [
9
          {
10
               "ip": "123.98.689.7",
11
               "domain": "mycompany.com",
12
               "weight": 50
13
          }
14
     ],

The parameters for this endpoint are mentioned in the table below.

Since ips is an array of objects, it has sub attributes which are:

Response

2. Update a sender

You can start updating your existing sender by using the endpoint https://api.brevo.com/v3/senders/{senderId} with the calling method PUT. To call the endpoint, the cURL request below can be used:

1
curl --request PUT \
2
     --url https://api.brevo.com/v3/senders/24 \
3
     --header 'accept: application/json' \
4
     --header 'api-key: ' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
     "ips": [
9
          {
10
               "ip": "123.98.689.7",
11
               "domain": "mycompany.com",
12
               "weight": 50
13
          }
14
     ],
15
     "name": "Newsletter",
16
     "email": "newsletter@mycompany.com"
17
}
18
'

The attributes of Update a sender are in two parts, path params and body params.

Path params

Body params

Since ips is an array of objects, it has sub attributes which are:

Response

3. Get the list of all your senders

You can use the endpoint https://api.brevo.com/v3/senders with the calling method GET. The cURL request for this endpoint is mentioned below:

1
curl --request GET \
2
     --url 'https://api.brevo.com/v3/senders?ip=192.168.8.138&domain=mydomain.com' \
3
     --header 'accept: application/json' \
4
     --header 'api-key: '

The attributes for this endpoint are defined in the table below:

Response

Delete a sender

You can use the endpoint https://api.brevo.com/v3/senders/{senderId} with the method DELETE. If you want to implement this endpoint in your preferred language, you can use the below code.

The cURL request for this endpoint is below.

1
curl --request DELETE \
2
     --url https://api.brevo.com/v3/senders/245 \
3
     --header 'accept: application/json' \
4
     --header 'api-key: '

There is only one attribute for deleting a sender which is senderId. You get the senderId after your create the sender and the API returns an Id in the response which is your senderId.

Response