postal
Pedir acesso
Audiência

Tópicos

Assuntos que o contato escolhe receber ou não, com padrão opt-in ou opt-out.

Tópicos são os assuntos que o contato escolhe receber ou não, como "Novidades" ou "Pesquisas". Eles aparecem na página de preferências que o contato abre pelo link de descadastro. Cada contato tem, para cada tópico, a própria escolha (opt_in ou opt_out) ou, se não escolheu, o padrão do tópico (default_subscription).

CampoValores
default_subscriptionopt_in: quem não escolheu recebe. opt_out: só recebe quem escolheu receber. Não muda depois de criado.
visibilitypublic: aparece na página de preferências. private (padrão): só você gerencia, pela API ou pelo painel.

#Listar tópicos

GET/topics

Chave de acesso total

Parâmetros de consulta

  • limitinteger
    De 1 a 100. Padrão: 20.
  • afterstring
    Cursor da próxima página.
  • beforestring
    Cursor da página anterior.
GET /topics

cURL

curl https://api.postal.so/topics \
  -H "Authorization: Bearer $POSTAL_API_KEY"

Node.js

const response = await fetch('https://api.postal.so/topics', {
  headers: {
    Authorization: `Bearer ${process.env.POSTAL_API_KEY}`,
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.get(
    "https://api.postal.so/topics",
    headers={"Authorization": f"Bearer {os.environ['POSTAL_API_KEY']}"},
    timeout=10,
)

data = response.json()

PHP

$client = new \GuzzleHttp\Client(['base_uri' => 'https://api.postal.so']);

$response = $client->get('topics', [
    'headers' => ['Authorization' => 'Bearer '.getenv('POSTAL_API_KEY')],
]);

$data = json_decode($response->getBody(), true);
200Resposta
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "topic",
      "id": "019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b",
      "name": "Novidades",
      "description": "Lançamentos e promoções, uma vez por semana.",
      "default_subscription": "opt_in",
      "visibility": "public",
      "created_at": "2026-10-20T10:05:00.000000Z",
      "updated_at": "2026-10-20T10:05:00.000000Z"
    }
  ]
}

#Criar um tópico

POST/topics

Chave de acesso total

Corpo da requisição

  • namestringobrigatório
    Nome, até 255 caracteres.
  • default_subscriptionstringobrigatório
    opt_in ou opt_out.
  • descriptionstring | null
    Descrição para o contato, até 500 caracteres.
  • visibilitystring
    public ou private (padrão).

Erros

  • 422validation_error
    Algum campo é inválido. A mensagem diz qual.
POST /topics

cURL

curl -X POST https://api.postal.so/topics \
  -H "Authorization: Bearer $POSTAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Novidades",
    "description": "Lançamentos e promoções, uma vez por semana.",
    "default_subscription": "opt_in",
    "visibility": "public"
  }'

Node.js

const response = await fetch('https://api.postal.so/topics', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.POSTAL_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Novidades',
    description: 'Lançamentos e promoções, uma vez por semana.',
    default_subscription: 'opt_in',
    visibility: 'public',
  }),
});

const data = await response.json();

Python

import os
import requests

response = requests.post(
    "https://api.postal.so/topics",
    headers={"Authorization": f"Bearer {os.environ['POSTAL_API_KEY']}"},
    json={
        "name": "Novidades",
        "description": "Lançamentos e promoções, uma vez por semana.",
        "default_subscription": "opt_in",
        "visibility": "public",
    },
    timeout=10,
)

data = response.json()

PHP

$client = new \GuzzleHttp\Client(['base_uri' => 'https://api.postal.so']);

$response = $client->post('topics', [
    'headers' => ['Authorization' => 'Bearer '.getenv('POSTAL_API_KEY')],
    'json' => [
        'name' => 'Novidades',
        'description' => 'Lançamentos e promoções, uma vez por semana.',
        'default_subscription' => 'opt_in',
        'visibility' => 'public',
    ],
]);

$data = json_decode($response->getBody(), true);
201Resposta
{
  "object": "topic",
  "id": "019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b"
}

#Obter um tópico

GET/topics/{id}

Chave de acesso total

Parâmetros de caminho

  • idstringobrigatório
    ID do tópico.

Erros

  • 404not_found
    O recurso não existe ou é de outro time.
GET /topics/{id}

cURL

curl https://api.postal.so/topics/019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b \
  -H "Authorization: Bearer $POSTAL_API_KEY"

Node.js

const response = await fetch('https://api.postal.so/topics/019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b', {
  headers: {
    Authorization: `Bearer ${process.env.POSTAL_API_KEY}`,
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.get(
    "https://api.postal.so/topics/019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b",
    headers={"Authorization": f"Bearer {os.environ['POSTAL_API_KEY']}"},
    timeout=10,
)

data = response.json()

PHP

$client = new \GuzzleHttp\Client(['base_uri' => 'https://api.postal.so']);

$response = $client->get('topics/019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b', [
    'headers' => ['Authorization' => 'Bearer '.getenv('POSTAL_API_KEY')],
]);

$data = json_decode($response->getBody(), true);
200Resposta
{
  "object": "topic",
  "id": "019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b",
  "name": "Novidades",
  "description": "Lançamentos e promoções, uma vez por semana.",
  "default_subscription": "opt_in",
  "visibility": "public",
  "created_at": "2026-10-20T10:05:00.000000Z",
  "updated_at": "2026-10-20T10:05:00.000000Z"
}

#Atualizar um tópico

PATCH/topics/{id}

Chave de acesso total

Muda nome, descrição ou visibilidade. default_subscription não pode mudar, porque os contatos sem escolha já seguem o padrão atual.

Parâmetros de caminho

  • idstringobrigatório
    ID do tópico.

Corpo da requisição

  • namestring
    Novo nome.
  • descriptionstring | null
    Nova descrição.
  • visibilitystring
    public ou private.

Erros

  • 422validation_error
    Campo inválido ou tentativa de mudar default_subscription.
  • 404not_found
    O recurso não existe ou é de outro time.
PATCH /topics/{id}

cURL

curl -X PATCH https://api.postal.so/topics/019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b \
  -H "Authorization: Bearer $POSTAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "visibility": "private"
  }'

Node.js

const response = await fetch('https://api.postal.so/topics/019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.POSTAL_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    visibility: 'private',
  }),
});

const data = await response.json();

Python

import os
import requests

response = requests.patch(
    "https://api.postal.so/topics/019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b",
    headers={"Authorization": f"Bearer {os.environ['POSTAL_API_KEY']}"},
    json={
        "visibility": "private",
    },
    timeout=10,
)

data = response.json()

PHP

$client = new \GuzzleHttp\Client(['base_uri' => 'https://api.postal.so']);

$response = $client->patch('topics/019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b', [
    'headers' => ['Authorization' => 'Bearer '.getenv('POSTAL_API_KEY')],
    'json' => [
        'visibility' => 'private',
    ],
]);

$data = json_decode($response->getBody(), true);
200Resposta
{
  "object": "topic",
  "id": "019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b"
}

#Excluir um tópico

DELETE/topics/{id}

Chave de acesso total

Remove o tópico e as escolhas dos contatos sobre ele.

Parâmetros de caminho

  • idstringobrigatório
    ID do tópico.

Erros

  • 404not_found
    O recurso não existe ou é de outro time.
DELETE /topics/{id}

cURL

curl -X DELETE https://api.postal.so/topics/019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b \
  -H "Authorization: Bearer $POSTAL_API_KEY"

Node.js

const response = await fetch('https://api.postal.so/topics/019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.POSTAL_API_KEY}`,
  },
});

const data = await response.json();

Python

import os
import requests

response = requests.delete(
    "https://api.postal.so/topics/019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b",
    headers={"Authorization": f"Bearer {os.environ['POSTAL_API_KEY']}"},
    timeout=10,
)

data = response.json()

PHP

$client = new \GuzzleHttp\Client(['base_uri' => 'https://api.postal.so']);

$response = $client->delete('topics/019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b', [
    'headers' => ['Authorization' => 'Bearer '.getenv('POSTAL_API_KEY')],
]);

$data = json_decode($response->getBody(), true);
200Resposta
{
  "object": "topic",
  "id": "019a1d95-4c5d-7e6f-8a7b-8c9d0e1f2a3b",
  "deleted": true
}