Étapes à venir

GET /api/v1/series/upcoming Liste les étapes de vos séries actives qui ne sont pas encore parties, de la plus proche à la plus lointaine, toutes séries confondues. C'est la lecture que l'API ne permettait pas : une série publiée était visible, et rien ne disait quand ses étapes partiraient. Les moments sont calculés — date de départ, attentes cumulées le long du chemin, puis heure d'envoi de l'étape — par la même fonction que celle de l'éditeur, du calendrier et du moteur d'envoi. Cet endpoint ne peut pas annoncer une heure que l'envoi ne respectera pas.

Autorisation

RôleAccès
OWNERAutorisé
ADMINAutorisé
MEMBERAutorisé

Exemple

bash
curl -s 'https://www.agentsmail.io/api/v1/series/upcoming' \
  -H "x-api-key: $AGENTMAIL_API_KEY"

Réponse

CodeQuand
200Les étapes à venir, éventuellement une liste vide
401Clé absente ou invalide

Champs de la réponse

ChampTypeDescription
successbooleanToujours true ici
dataarrayLes étapes encore à venir, de la plus proche à la plus lointaine
data[].idstringPréfixé series: — jamais un identifiant de campagne
data[].namestringLe nom que portera la campagne : <series name> · step N
data[].dueAtstringLe moment où l'étape part, en ISO 8601
data[].campaignIdnullToujours null : la campagne n'existe pas encore

Exemple de réponse

json
{
  "success": true,
  "data": [
    {
      "id": "series:3c3c3c3c-9999-4ddd-8eee-ffff11112222",
      "name": "March launch · step 2",
      "dueAt": "2026-03-18T08:00:00.000Z",
      "campaignId": null
    }
  ]
}

Remarques

Rien ici n'existe encore en tant que campagne, d'où le campaignId à null et l'identifiant préfixé. La campagne est créée à dueAt, nommée exactement comme l'indique name, et se lit dès lors par l'API Campagnes comme n'importe quelle autre. Créer les campagnes à l'avance est volontairement impossible : un brouillon posé dans la liste pourrait être envoyé à la main, hors de l'ordre de la série. Une étape dont le moment est passé n'est pas listée — elle a déjà sa campagne.

Voir aussi