POST /api/v1/lists
Une liste est le conteneur dans lequel vivent les contacts. Créez-en une, puis alimentez-la avec les endpoints de contacts. La modification et la suppression ne sont pas encore exposées ; la lecture des listes que vous avez déjà se trouve dans Découverte.
La liste est toujours créée dans l'organisation de la clé d'API ; la réponse porte son id, prêt à servir dans les endpoints de contacts.
Autorisation
| Rôle dans l'organisation | Cet endpoint |
|---|---|
OWNER | Autorisé |
ADMIN | Autorisé |
MEMBER | Refusé — 403 |
Corps de la requête
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
name | string | oui | De 1 à 100 caractères |
Exemple
bash
curl -X POST -H "x-api-key: $AGENTMAIL_API_KEY" -H "content-type: application/json" \
-d '{"name":"Newsletter"}' \
"https://www.agentsmail.io/api/v1/lists"Réponse
201 Created— la ressource créée.401 Unauthorized— clé absente ou invalide, ou son propriétaire a quitté l'organisation.403 Forbidden— le propriétaire de la clé estmemberde l'organisation, pasadmin.429 Too Many Requests— plus de 120 requêtes en une minute pour cette clé.
Champs de la réponse
| Champ | Type | Description |
|---|---|---|
success | boolean | Indique si l'opération a réussi |
data.id | string | Identifiant unique de la liste |
data.name | string | Nom de la liste |
data.contactCount | number | Contacts qu'elle contient |
data.createdAt | string | Date de création ISO |
data.updatedAt | string | Date ISO de la dernière modification |
Exemple de réponse
json
{
"success": true,
"data": {
"id": "4d19c0a2",
"name": "Newsletter",
"contactCount": 128,
"createdAt": "2026-08-23T10:22:05.000Z",
"updatedAt": "2026-08-23T10:22:05.000Z"
}
}