Créer une liste

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'organisationCet endpoint
OWNERAutorisé
ADMINAutorisé
MEMBERRefusé — 403
Une clé porte le rôle que son créateur détient dans cette organisation — jamais un rôle sur AgentsMail lui-même. Voir Clés d'API.

Corps de la requête

ChampTypeObligatoireDescription
namestringouiDe 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é est member de l'organisation, pas admin.
  • 429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

ChampTypeDescription
successbooleanIndique si l'opération a réussi
data.idstringIdentifiant unique de la liste
data.namestringNom de la liste
data.contactCountnumberContacts qu'elle contient
data.createdAtstringDate de création ISO
data.updatedAtstringDate 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"
  }
}

Voir aussi