Audiences et contacts

Une audience est une liste de contacts auxquels vous pouvez envoyer des campagnes. Un contact appartient à exactement une audience ; la même adresse e-mail dans deux audiences correspond à deux contacts, chacun avec son propre état de désabonnement.

Audiences

cURL

curl -X POST https://api.spacepost.dev/audiences \
  -H "Authorization: Bearer $SPACEPOST_API_KEY" -H "Content-Type: application/json" \
  -d '{ "name": "Newsletter" }'

Response

{ "object": "audience", "id": "0192e1c4-0000-7000-8000-0000000000a1", "name": "Newsletter" }

Node.js

const { data } = await spacepost.audiences.create({ name: "Newsletter" });

GET /audiences, GET /audiences/{id} et DELETE /audiences/{id} complètent l’ensemble. Supprimer une audience supprime ses contacts. Les noms d’audience font de 1 à 100 caractères.

Contacts

Les contacts se trouvent sous leur audience : /audiences/{audienceId}/contacts.

Créer un contact

emailstringrequis

Unique au sein de l'audience. Stocké en minuscules. Créer un doublon renvoie 422.

first_namestringfacultatif

Jusqu'à 100 caractères. Utilisé par {{{FIRST_NAME}}}.

last_namestringfacultatif

Jusqu'à 100 caractères. Utilisé par {{{LAST_NAME}}}.

unsubscribedbooleanfacultatif

Crée le contact déjà désabonné (par exemple lors de l'import d'une liste de suppression). Vaut false par défaut.

contacts.ts

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

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

const { data: audience, error } = await spacepost.audiences.create({ name: "Newsletter" });
if (error) throw new Error(error.message);

// Create
await spacepost.contacts.create({
  audienceId: audience.id,
  email: "ada@example.com",
  firstName: "Ada",
  lastName: "Lovelace",
});

// Read by email (or by id)
const { data: contact } = await spacepost.contacts.get({ audienceId: audience.id, email: "ada@example.com" });
console.log(contact?.unsubscribed);

// Update
await spacepost.contacts.update({ audienceId: audience.id, email: "ada@example.com", firstName: "Augusta" });

// List, newest first
const { data: page } = await spacepost.contacts.list({ audienceId: audience.id, limit: 50 });
console.log(page?.data.length, page?.has_more);

// Unsubscribe manually, then delete
await spacepost.contacts.update({ audienceId: audience.id, email: "ada@example.com", unsubscribed: true });
await spacepost.contacts.remove({ audienceId: audience.id, email: "ada@example.com" });

cURL

AUD=0192e1c4-0000-7000-8000-0000000000a1

# create
curl -X POST https://api.spacepost.dev/audiences/$AUD/contacts \
  -H "Authorization: Bearer $SPACEPOST_API_KEY" -H "Content-Type: application/json" \
  -d '{ "email": "ada@example.com", "first_name": "Ada", "last_name": "Lovelace" }'
# => { "object": "contact", "id": "..." }

# get by email (URL-encode the @) or by id
curl "https://api.spacepost.dev/audiences/$AUD/contacts/ada%40example.com" -H "Authorization: Bearer $SPACEPOST_API_KEY"

# update
curl -X PATCH "https://api.spacepost.dev/audiences/$AUD/contacts/ada%40example.com" \
  -H "Authorization: Bearer $SPACEPOST_API_KEY" -H "Content-Type: application/json" \
  -d '{ "unsubscribed": true }'

# delete
curl -X DELETE "https://api.spacepost.dev/audiences/$AUD/contacts/ada%40example.com" -H "Authorization: Bearer $SPACEPOST_API_KEY"

Python

base = f"https://api.spacepost.dev/audiences/{audience_id}/contacts"
h = {"Authorization": f"Bearer {os.environ['SPACEPOST_API_KEY']}"}

requests.post(base, headers=h, json={"email": "ada@example.com", "first_name": "Ada"})
requests.patch(f"{base}/ada@example.com", headers=h, json={"unsubscribed": True})

Un contact ressemble à ceci :

{
  "object": "contact",
  "id": "0192e1c4-0000-7000-8000-0000000000c1",
  "email": "ada@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "created_at": "2026-10-23T14:00:00.000Z",
  "unsubscribed": false
}

DELETE renvoie { "object": "contact", "contact": "ada@example.com", "deleted": true }. Là où un idOrEmail est attendu, vous pouvez passer l’id du contact ou son adresse e-mail.

Désabonnements

Un contact avec unsubscribed: true est ignoré par toutes les campagnes. Les contacts se désabonnent eux-mêmes via le lien de vos e-mails (Désabonnement), et vous pouvez définir l’indicateur via l’API lorsque vous apprenez un opt-out ailleurs.

Contacts et liste de suppression

Le désabonnement est propre à chaque contact et n’affecte que les campagnes. La liste de suppression s’applique à toute l’équipe et à tous les e-mails, y compris transactionnels. Les rebonds définitifs et les plaintes s’y ajoutent automatiquement.

Importer

Importez avec une boucle, en respectant la limite de débit (10 requêtes par seconde sur Free et Pro) :

for (const row of rows) {
  const { error } = await spacepost.contacts.create({ audienceId, email: row.email, firstName: row.first });
  if (error?.name === "rate_limit_exceeded") await new Promise((r) => setTimeout(r, 1000));
}

N’importez que des personnes qui ont accepté de recevoir vos messages. Voir Conformité.