Receber emails: Contatos e público

Salvar segmento

Cria ou atualiza um segmento desta caixa.

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

Um segmento pertence a uma caixa. Para usar em outra caixa, salve uma cópia lá.

i

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

Argumentos

  • segment_idstringopcional

    Deixe de fora para criar um segmento novo.

  • namestringobrigatório

    Até 200 caracteres.

  • whereobjectobrigatório

    O filtro. Mesmo formato do list_contacts.

  • sortobjectopcional

    { field }: email, created_at, last_open_at, last_click_at, open_count ou click_count.

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "save_segment",
        args: {
          name: "Opened in 30 days",
          where: {
            last_open_at: {
              within_days: 30
            }
          }
        }
      }
    ]
  },
  { 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": "save_segment",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "segment": {
          "segment_id": "seg_8Hq2",
          "name": "Opened in 30 days",
          "where": {
            "last_open_at": {
              "within_days": 30
            }
          },
          "sort": null,
          "created_at": "2026-11-21T10:00:00Z",
          "updated_at": "2026-11-21T10:00:00Z"
        }
      }
    }
  ]
}

Campos da resposta

  • segment

    O segmento salvo.

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.

  • 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.