Públicos e contatos

Um público (audience) é uma lista de contatos para os quais você pode enviar campanhas. Um contato pertence a exatamente um público; o mesmo endereço de e-mail em dois públicos são dois contatos, cada um com o seu próprio estado de cancelamento de inscrição.

Públicos

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} completam o conjunto. Excluir um público exclui os contatos dele. Os nomes de públicos têm de 1 a 100 caracteres.

Contatos

Os contatos ficam sob o seu público: /audiences/{audienceId}/contacts.

Criar contato

emailstringobrigatório

Único dentro do público. Armazenado em minúsculas. Criar um duplicado retorna 422.

first_namestringopcional

Até 100 caracteres. Usado por {{{FIRST_NAME}}}.

last_namestringopcional

Até 100 caracteres. Usado por {{{LAST_NAME}}}.

unsubscribedbooleanopcional

Cria o contato já com a inscrição cancelada (por exemplo, ao importar uma lista de supressão). O padrão é 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})

Um contato tem este formato:

{
  "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 retorna { "object": "contact", "contact": "ada@example.com", "deleted": true }. Onde um idOrEmail é esperado, você pode passar o id do contato ou o endereço de e-mail.

Cancelamentos de inscrição

Um contato com unsubscribed: true é ignorado por todas as campanhas. Os contatos cancelam a própria inscrição pelo link nos seus e-mails (Cancelar inscrição), e você pode definir o flag pela API quando souber de um opt-out feito em outro lugar.

Contatos versus a lista de supressão

O cancelamento de inscrição é por contato e afeta apenas as campanhas. A lista de supressão vale para toda a equipe e se aplica a todos os e-mails, inclusive os transacionais. Rejeições permanentes e reclamações são adicionadas a ela automaticamente.

Importação

Importe com um laço, respeitando o limite de taxa (10 requisições por segundo no Free e no 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));
}

Importe apenas pessoas que concordaram em receber notícias suas. Veja Conformidade.