arrobaMail
Testar grátis
Módulo 123 endpoints

Subscription /subscription

Sem autenticação. Endpoints públicos para autoatendimento de assinantes.

Endpoints

3 no total
GET/subscription/:xsidPúblico

Obter dados do assinante

Não retorna campos internos (internal=true).

Parâmetros de rota

NomeDescrição
xsidID codificado do assinante (formato sid-lid-mid). Padrão: [qwertyuiops]{7,40}

Exemplo

curl -X GET "https://envios.arrobamail.com/v3/api/subscription/{XSID}"

Resposta 200

{
  "email": "[email protected]",
  "nombre": "Juan",
  "listData": { "name": "Newsletter", "description": "..." },
  "customFields": [
    { "id": 15, "name": "Ciudad", "value": "Buenos Aires", "type": "text" }
  ]
}

Erros

StatusCodeDescrição
404not_foundAssinante não encontrado
410unsubscribedAssinante já cancelou a inscrição
PUT/subscription/:xsidPúblico

Atualizar dados do assinante

Campos date exigem timestamp Unix. Dropdown/radio devem corresponder às opções. Campos internos são ignorados.

Parâmetros de rota

NomeDescrição
xsidID codificado do assinante

Request body · application/json

NomeTipoObrig.Descrição
nombrestringNãoNovo nome
customFieldsobjectNão{ "fieldId": "value" }

Exemplo

curl -X PUT "https://envios.arrobamail.com/v3/api/subscription/{XSID}" \
  -H "Content-Type: application/json" \
  -d '{
  "nombre": "...",
  "customFields": {}
}'

Resposta 200

{ "success": true }
DELETE/subscription/:xsidPúblico

Cancelar inscrição

Parâmetros de rota

NomeDescrição
xsidID codificado do assinante

Query params

NomeTipoObrig.DefaultDescrição
spamstringNão-"1" para registrar como reclamação de spam

Exemplo

curl -X DELETE "https://envios.arrobamail.com/v3/api/subscription/{XSID}"

Resposta 200

{ "success": true }

Comece com o arrobaMail
em menos de 5 minutos.

Plano Gratuito, gerações de IA incluídas, sem cartão de crédito e suporte real em português.

Testar grátis agora
WhatsAppA equipe responde