put https://api.brevo.com/v3/senders/
Code Examples
You can use as reference the code below to implement this call in your preferred language.
Check all our official API clients here
const SibApiV3Sdk = require('sib-api-v3-sdk');
const defaultClient = SibApiV3Sdk.ApiClient.instance;
let apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
let apiInstance = new SibApiV3Sdk.SendersApi();
let senderId = 1;
let opts = {
'sender': new SibApiV3Sdk.UpdateSender()
};
opts.sender = {
name: 'senderName',
email: '[email protected]',
ips: [
{
'ip' : '1.1.1.1',
'domain' : 'example.com'
}
],
}
apiInstance.updateSender(senderId, opts).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR API KEY');
$apiInstance = new SendinBlue\Client\Api\SendersApi(
new GuzzleHttp\Client(),
$config
);
$senderId = 1;
$sender = new \SendinBlue\Client\Model\UpdateSender();
$sender['name'] = 'senderName';
$sender['email'] = '[email protected]';
$sender['ips'] = array(
array('ip' => '1.1.1.1', 'domain' => 'example.com')
);
try {
$apiInstance->updateSender($senderId, $sender);
} catch (Exception $e) {
echo 'Exception when calling SendersApi->updateSender: ', $e->getMessage(), PHP_EOL;
}
?>
from __future__ import print_function
import time
import sib_api_v3_sdk
from sib_api_v3_sdk.rest import ApiException
from pprint import pprint
configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['api-key'] = 'YOUR API KEY'
api_instance = sib_api_v3_sdk.SendersApi(sib_api_v3_sdk.ApiClient(configuration))
sender_id = 1
sender = sib_api_v3_sdk.UpdateSender(name = "senderName", email="[email protected]", ips=[{
'ip' : '1.1.1.1',
'domain' : 'example.com'
}])
try:
api_response = api_instance.update_sender(sender_id, sender=sender)
pprint(api_response)
except ApiException as e:
print("Exception when calling SendersApi->update_sender: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript');
let apiInstance = new SibApiV3Sdk.SendersApi()
let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
apiKey.apiKey = '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'
let senderId = 1;
let sender = new SibApiV3Sdk.UpdateSender();
sender.name = 'senderName';
sender.email = '[email protected]';
sender.ips = [{'ip' : '1.1.1.1', 'domain' : 'example.com'}]
apiInstance.updateSender(senderId, sender).then(function(data) {
console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, function(error) {
console.error(error);
});
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;
using System;
using System.Collections.Generic;
using System.Diagnostics;
namespace Sendinblue
{
class Program
{
static void Main(string[] args)
{
Configuration.Default.ApiKey.Add("api-key", "YOUR API KEY");
var apiInstance = new SendersApi();
long? senderId = 1;
string name = "senderName";
string email = "[email protected]";
string ip = "1.1.1.1";
var domain = "example.com";
long? weight = 100;
var createSenderIps = new CreateSenderIps(ip, domain, weight);
List<CreateSenderIps> ips = new List<CreateSenderIps>(); //optional
ips.Add(createSenderIps);
try
{
var sender = new UpdateSender(name, email, ips);
apiInstance.UpdateSender(senderId, sender);
Console.ReadLine();
}
catch (Exception e)
{
Debug.WriteLine(e.Message);
Console.WriteLine(e.Message);
Console.ReadLine();
}
}
}
}
# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
# Configure API key authorization: api-key
config.api_key['api-key'] = 'YOUR API KEY'
end
api_instance = SibApiV3Sdk::SendersApi.new
sender_id = 789 # Integer | Id of the sender
opts = {
sender: SibApiV3Sdk::UpdateSender.new # UpdateSender | sender's name
}
opts[:sender] = {
'email' => '[email protected]',
'ips' => [
{
'ip' => '1.1.1.1',
'domain' => 'example.com'
}
],
'name' => 'sender_name'
}
begin
#Update a sender
api_instance.update_sender(sender_id, opts)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling SendersApi->update_sender: #{e}"
end