Contatos: segmentos

Salvar segmento

Salve uma consulta com um nome, para sua aplicação e o dashboard poderem executá-la depois. Os contatos não são copiados: o segmento é reavaliado toda vez que roda.

POSThttps://g.sendcorex.com/v1/contactscommand: save_segment
i

Precisa do scope contact:create na sua API key.

i

O where é validado ao salvar: uma chave ou campo desconhecido falha com INVALID_ARGS agora, não na próxima execução.

Argumentos

  • segment_idstringopcional

    Seu próprio id. Gerado quando omitido. Salvar com um id que existe substitui aquele segmento.

    ex.: "engaged-vips"

  • namestringopcional

    Nome de exibição.

    ex.: "Engaged VIPs"

  • whereobjectobrigatório

    O mesmo where de Query Contacts.

  • sortstring | objectopcional

    O mesmo sort de Query Contacts.

    ex.: "open_rate"

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "save_segment",
        args: {
          segment_id: "engaged-vips",
          name: "Engaged VIPs",
          where: {
            tags: {
              has: "vip"
            },
            last_open_at: {
              within_days: 30
            }
          },
          sort: "open_rate"
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

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",
      "took_ms": 14,
      "data": {
        "segment_id": "engaged-vips",
        "name": "Engaged VIPs",
        "where": {
          "tags": {
            "has": "vip"
          },
          "last_open_at": {
            "within_days": 30
          }
        },
        "sort": {
          "field": "open_rate"
        },
        "created_at": "2026-10-10T12:00:00.000Z",
        "updated_at": "2026-10-10T12:00:00.000Z"
      }
    }
  ]
}

Campos da resposta

  • (segment)

    O segmento como ficou 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.

  • 401INVALID_API_KEY

    A API key não existe, foi revogada ou foi desativada no dashboard.

  • 429RATE_LIMITED

    Mais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.

  • CMDMISSING_SCOPE

    A API key não tem o scope que este comando precisa. Os outros comandos do request rodam mesmo assim.

  • CMDINVALID_ARGS

    Um argumento obrigatório está faltando ou é inválido: email, valor de campo, opção de enum, chave do where, id de lista…

  • CMDINTERNAL

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