Receber e-mails: Newsletters

Obter opções de cancelamento

Dá para cancelar a inscrição na lista que enviou este e-mail, como, e você já cancelou?

POSThttps://g.sendcorex.com/v1command: get_unsubscribe_options

Argumentos

  • idstringobrigatório

    Um e-mail que você recebeu.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "get_unsubscribe_options",
        args: {
          id: "Vj0xQUJDMTIz"
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Resposta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "get_unsubscribe_options",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "can_unsubscribe": true,
        "method": "one_click",
        "one_click": true,
        "http": "https://shop.com/u/abc",
        "mailto": "mailto:unsub@shop.com?subject=unsubscribe",
        "list_id": "Shop News <news.shop.com>",
        "list_key": "news.shop.com",
        "from_email": "news@shop.com"
      }
    }
  ]
}

Campos da resposta

  • method

    one_click, mailto ou http — o que unsubscribe vai usar.

  • list_key

    O List-Id quando o e-mail tem um; senão, o remetente. A mesma newsletter vinda de outro endereço é a mesma lista.

  • status

    Presente quando você já pediu: done, pending ou failed.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401TOKEN_EXPIRED

    O access token expirou. Chame Refresh Token e repita a requisição.

  • 401INVALID_TOKEN

    O token está malformado, é desconhecido ou foi revogado.

  • 429RATE_LIMITED

    Mais de 15 requisições/s ou 15 em andamento para o mesmo IP + caixa de correio. Espere o número de segundos indicado em Retry-After.

  • CMDINVALID_ARGS

    Um argumento obrigatório está ausente ou é inválido.

  • CMDNOT_FOUND

    A mensagem, conversa ou pasta não existe para este token.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.