put https://api.brevo.com/v3/contacts/lists/
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');
let defaultClient = SibApiV3Sdk.ApiClient.instance;
let apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';
let apiInstance = new SibApiV3Sdk.ContactsApi();
let listId = 1;
let updateList = new SibApiV3Sdk.UpdateList();
updateList.name = "mySecondList";
apiInstance.updateList(listId, updateList).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\ContactsApi(
new GuzzleHttp\Client(),
$config
);
$listId = 1;
$updateList = new \SendinBlue\Client\Model\UpdateList();
$updateList['name'] = 'mySecondList';
try {
$apiInstance->updateList($listId, $updateList);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->updateList: ', $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.ContactsApi(sib_api_v3_sdk.ApiClient(configuration))
list_id = 5
update_list = sib_api_v3_sdk.UpdateList(name='mySecondList')
try:
api_instance.update_list(list_id, update_list)
except ApiException as e:
print("Exception when calling ContactsApi->update_list: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript');
let apiInstance = new SibApiV3Sdk.ContactsApi()
let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
let listId = 2;
let updateList = new SibApiV3Sdk.UpdateList();
updateList.name = "mySecondList";
apiInstance.updateList(listId, updateList).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
package sibApi;
import sendinblue.ApiClient;
import sendinblue.Configuration;
import sendinblue.auth.ApiKeyAuth;
import sibModel.*;
public class Program {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: api-key
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("api-key");
apiKey.setApiKey("YOUR API KEY");
try {
ContactsApi api = new ContactsApi();
Long listId = 2l;
UpdateList updateList = new UpdateList();
updateList.setName("myListName");
api.updateList(listId, updateList);
} catch (Exception e) {
System.out.println("Exception occurred:- " + e.getMessage());
}
}
}
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;
using System;
using System.Diagnostics;
namespace Sendinblue
{
class Program
{
static void Main(string[] args)
{
Configuration.Default.ApiKey.Add("api-key", "YOUR API KEY");
var apiInstance = new ContactsApi();
long? listId = 2;
string name = "myListName";
long? folderId = null;
try
{
var updateList = new UpdateList(name, folderId);
apiInstance.UpdateList(listId, updateList);
Console.ReadLine();
}
catch (Exception e)
{
Debug.WriteLine(e.Message);
Console.WriteLine(e.Message);
Console.ReadLine();
}
}
}
}
package main
import (
"fmt"
"context"
sib_api_v3_sdk "./lib"
)
func main() {
var ctx context.Context
var cli = sib_api_v3_sdk.APIClient{
cfg: sib_api_v3_sdk.NewConfiguration(),
}
//Configure API key authorization: api-key
cli.cfg.AddDefaultHeader("api-key", "YOUR_API_KEY")
sib := sib_api_v3_sdk.NewAPIClient(cli.cfg)
listId := int64(2)
body := UpdateList{
Name: "myListName",
FolderId: int64(1),
}
resp, err := sib.ContactsApi.UpdateList(ctx, body, listId)
if err!=nil{
fmt.Println("Error in ContactsApi->UpdateList ",err.Error())
return
}
fmt.Println( "UpdateList response:",resp)
return
}
# 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::ContactsApi.new
list_id = 789 # Integer | Id of the list
update_list = SibApiV3Sdk::UpdateList.new # UpdateList | Values to update a list
update_list = {
'name'=> 'mySecondList'
}
begin
#Update a list
api_instance.update_list(list_id, update_list)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ContactsApi->update_list: #{e}"
end