Pubblici e contatti

Un pubblico è una lista di contatti a cui puoi inviare campagne. Un contatto appartiene a un solo pubblico; lo stesso indirizzo email in due pubblici corrisponde a due contatti, ciascuno con il proprio stato di iscrizione.

Pubblici

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} e DELETE /audiences/{id} completano l’insieme. Eliminare un pubblico elimina i suoi contatti. I nomi dei pubblici sono lunghi da 1 a 100 caratteri.

Contatti

I contatti stanno sotto il loro pubblico: /audiences/{audienceId}/contacts.

Crea contatto

emailstringobbligatorio

Univoca all'interno del pubblico. Salvata in minuscolo. Creare un duplicato restituisce 422.

first_namestringopzionale

Fino a 100 caratteri. Usato da {{{FIRST_NAME}}}.

last_namestringopzionale

Fino a 100 caratteri. Usato da {{{LAST_NAME}}}.

unsubscribedbooleanopzionale

Crea il contatto già disiscritto (ad esempio quando importi una lista di soppressione). Il valore predefinito è false.

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 contatto ha questo aspetto:

{
  "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 restituisce { "object": "contact", "contact": "ada@example.com", "deleted": true }. Dove è previsto un idOrEmail puoi passare l’id del contatto oppure l’indirizzo email.

Disiscrizioni

Un contatto con unsubscribed: true viene saltato da ogni campagna. I contatti si disiscrivono da soli tramite il link nelle tue email (Annullamento dell’iscrizione), e puoi impostare il flag tramite l’API quando vieni a sapere di una disiscrizione avvenuta altrove.

Contatti e lista di soppressione

La disiscrizione è per contatto e riguarda solo le campagne. La lista di soppressione vale per tutto il team e si applica a ogni email, comprese quelle transazionali. I rimbalzi definitivi e i reclami vi vengono aggiunti automaticamente.

Importazione

Importa con un ciclo, rispettando il limite di frequenza (10 richieste al secondo su Free e 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));
}

Importa solo persone che hanno accettato di ricevere tue notizie. Vedi Conformità.