Abonnés
Inscrire un lot d'adresses
Jusqu’à 1 000 abonnés en un appel. Jusqu’à 100, le traitement est immédiat et la réponse rend compte ligne par ligne (200). Au-delà, le lot part en tâche de fond comme un import et la réponse est un import à suivre (202). Une ligne en erreur ne fait pas perdre les autres.
POST
/
api
/
v1
/
lists
/
{list}
/
subscribers
/
batch
Inscrire un lot d'adresses
curl --request POST \
--url https://{host}/api/v1/lists/{list}/subscribers/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subscribers": [
{
"email": "ada@example.com",
"tags": [
"client"
]
},
{
"email": "alan@example.com",
"locale": "en"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subscribers: [
{email: 'ada@example.com', tags: ['client']},
{email: 'alan@example.com', locale: 'en'}
]
})
};
fetch('https://{host}/api/v1/lists/{list}/subscribers/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/api/v1/lists/{list}/subscribers/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subscribers' => [
[
'email' => 'ada@example.com',
'tags' => [
'client'
]
],
[
'email' => 'alan@example.com',
'locale' => 'en'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://{host}/api/v1/lists/{list}/subscribers/batch"
payload = { "subscribers": [
{
"email": "ada@example.com",
"tags": ["client"]
},
{
"email": "alan@example.com",
"locale": "en"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": [
{
"index": 0,
"email": "ada@example.com",
"id": "9d5c2a1e-8f3b-4c7a-9e21-3b8f0c6d4a12",
"outcome": "subscribed"
},
{
"index": 1,
"email": "alan@example.com",
"outcome": "failed",
"message": "This address is blocked."
}
],
"meta": {
"added": 1,
"updated": 0,
"failed": 1
}
}{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "draft",
"file_name": "<string>",
"processed": 123,
"added": 123,
"updated": 123,
"failed": 123,
"errors": [
{}
],
"created_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"url": "<string>"
},
"meta": {
"queued": 123
}
}{
"message": "Unauthenticated."
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "Le champ email doit être une adresse e-mail valide.",
"errors": {}
}Autorisations
Jeton d'API. Aptitude « read » : routes GET seulement. « read + write » : toutes les routes.
En-têtes
Rejouez une écriture sans risque : la même clé rend la première réponse pendant 24 heures (en-tête Idempotent-Replay: true).
Maximum string length:
255Paramètres de chemin
L'identifiant (uuid) de la liste.
Corps
application/json
⌘I
Inscrire un lot d'adresses
curl --request POST \
--url https://{host}/api/v1/lists/{list}/subscribers/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subscribers": [
{
"email": "ada@example.com",
"tags": [
"client"
]
},
{
"email": "alan@example.com",
"locale": "en"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subscribers: [
{email: 'ada@example.com', tags: ['client']},
{email: 'alan@example.com', locale: 'en'}
]
})
};
fetch('https://{host}/api/v1/lists/{list}/subscribers/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/api/v1/lists/{list}/subscribers/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'subscribers' => [
[
'email' => 'ada@example.com',
'tags' => [
'client'
]
],
[
'email' => 'alan@example.com',
'locale' => 'en'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://{host}/api/v1/lists/{list}/subscribers/batch"
payload = { "subscribers": [
{
"email": "ada@example.com",
"tags": ["client"]
},
{
"email": "alan@example.com",
"locale": "en"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": [
{
"index": 0,
"email": "ada@example.com",
"id": "9d5c2a1e-8f3b-4c7a-9e21-3b8f0c6d4a12",
"outcome": "subscribed"
},
{
"index": 1,
"email": "alan@example.com",
"outcome": "failed",
"message": "This address is blocked."
}
],
"meta": {
"added": 1,
"updated": 0,
"failed": 1
}
}{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "draft",
"file_name": "<string>",
"processed": 123,
"added": 123,
"updated": 123,
"failed": 123,
"errors": [
{}
],
"created_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"url": "<string>"
},
"meta": {
"queued": 123
}
}{
"message": "Unauthenticated."
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "Le champ email doit être une adresse e-mail valide.",
"errors": {}
}