Planification

Ajoutez scheduled_at à n’importe quelle requête d’envoi pour distribuer plus tard. L’e-mail est accepté immédiatement, reçoit le statut scheduled et un webhook email.scheduled est déclenché.

Formats

Format	Exemple
ISO 8601	2026-11-01T09:00:00Z, 2026-11-01T09:00:00+01:00
Langage naturel	in 30 seconds, in 10 minutes, in 2 hours, in 1 day, in 1 week

Le langage naturel s’écrit in <nombre> <unité>, où l’unité est l’une de second, sec, minute, min, hour, hr, day, week (le s du pluriel est facultatif). Le texte n’est pas sensible à la casse.

Autres règles :

• 30 jours maximum dans le futur. Au-delà, l’API renvoie 422 validation_error.
• Une heure dans le passé, ou à moins d’une seconde environ dans le futur, est traitée comme envoyer maintenant.
• Les chaînes ISO sans décalage de fuseau horaire sont interprétées par l’analyseur de dates du serveur ; incluez toujours Z ou un décalage.
• scheduled_at et scheduledAt sont tous deux acceptés.

Node.js

schedule.ts

import { SpacePost } from "@spacepost/node";

const spacepost = new SpacePost(process.env.SPACEPOST_API_KEY);

const { data, error } = await spacepost.emails.send({
  from: "Acme <hello@acme.com>",
  to: "user@example.com",
  subject: "Your trial ends tomorrow",
  html: "<p>Reminder.</p>",
  scheduledAt: "in 1 day", // or an ISO date: "2026-11-01T09:00:00Z"
});

if (error) console.error(error);
else console.log("Scheduled", data.id);

cURL

curl -X POST https://api.spacepost.dev/emails \
  -H "Authorization: Bearer $SPACEPOST_API_KEY" -H "Content-Type: application/json" \
  -d '{
    "from": "Acme <hello@acme.com>",
    "to": ["user@example.com"],
    "subject": "Your trial ends tomorrow",
    "html": "<p>Reminder.</p>",
    "scheduled_at": "2026-11-01T09:00:00Z"
  }'

Python

requests.post(
    "https://api.spacepost.dev/emails",
    headers={"Authorization": f"Bearer {os.environ['SPACEPOST_API_KEY']}"},
    json={
        "from": "Acme <hello@acme.com>",
        "to": ["user@example.com"],
        "subject": "Your trial ends tomorrow",
        "html": "<p>Reminder.</p>",
        "scheduled_at": "in 1 day",
    },
)

Replanifier

Seuls les e-mails au statut scheduled peuvent être modifiés. PATCH /emails/{id} remplace l’heure ; une nouvelle tâche est mise en file et l’ancienne devient sans effet.

Node.js

reschedule.ts

import { SpacePost } from "@spacepost/node";

const spacepost = new SpacePost(process.env.SPACEPOST_API_KEY);

const { error } = await spacepost.emails.update({
  id: "0192e1c4-7a3b-7c1e-9d2f-3b5a8e6f4c10",
  scheduledAt: "in 2 hours",
});
if (error) console.error(error);

cURL

curl -X PATCH https://api.spacepost.dev/emails/$EMAIL_ID \
  -H "Authorization: Bearer $SPACEPOST_API_KEY" -H "Content-Type: application/json" \
  -d '{ "scheduled_at": "2026-11-02T09:00:00Z" }'

Response (200)

{ "object": "email", "id": "0192e1c4-7a3b-7c1e-9d2f-3b5a8e6f4c10" }

Annuler

Node.js

cancel.ts

import { SpacePost } from "@spacepost/node";

const spacepost = new SpacePost(process.env.SPACEPOST_API_KEY);

const { error } = await spacepost.emails.cancel("0192e1c4-7a3b-7c1e-9d2f-3b5a8e6f4c10");
if (error) console.error(error); // 422 validation_error if it is no longer scheduled

cURL

curl -X POST https://api.spacepost.dev/emails/$EMAIL_ID/cancel -H "Authorization: Bearer $SPACEPOST_API_KEY"

Le statut devient canceled et l’e-mail n’est jamais envoyé. Annuler ou replanifier un e-mail qui n’est plus scheduled renvoie 422 validation_error (« Only scheduled emails can be canceled »).

Note

Les destinataires sont décomptés de votre quota au moment où l’e-mail est accepté, pas lorsqu’il est envoyé. L’annulation ne rembourse pas le quota pour l’instant.

Via SMTP

Définissez l’en-tête X-SpacePost-Scheduled-At sur une date ISO ou une valeur en langage naturel. Voir Relais SMTP.