Receber emails: Contatos e público

Apagar segmento

Apaga um segmento desta caixa.

POSThttps://g.sendcorex.com/v1command: delete_segment
i

Precisa da permissão de organizar (tokens só leitura não podem).

Argumentos

  • segment_idstringobrigatório

    O id do segmento.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "delete_segment",
        args: {
          segment_id: "seg_8Hq2"
        }
      }
    ]
  },
  { 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": "delete_segment",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "deleted": true
      }
    }
  ]
}

Campos da resposta

  • deleted

    true quando foi apagado.

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.

  • CMDNOT_FOUND

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

  • CMDREAD_ONLY_ACCESS

    O token ou app tem acesso Somente leitura e o comando escreve. Na rota de upload de anexo, é HTTP 403.

  • CMDINTERNAL

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