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.
https://g.sendcorex.com/v1/contactscommand: save_segmentPrecisa do scope contact:create na sua API key.
O where é validado ao salvar: uma chave ou campo desconhecido falha com INVALID_ARGS agora, não na próxima execução.
Argumentos
segment_idstringopcionalSeu próprio id. Gerado quando omitido. Salvar com um id que existe substitui aquele segmento.
ex.:
"engaged-vips"namestringopcionalNome de exibição.
ex.:
"Engaged VIPs"whereobjectobrigatórioO mesmo
wherede Query Contacts.sortstring | objectopcionalO mesmo
sortde 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.
- 401
INVALID_API_KEYA API key não existe, foi revogada ou foi desativada no dashboard.
- 429
RATE_LIMITEDMais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.
- CMD
MISSING_SCOPEA API key não tem o scope que este comando precisa. Os outros comandos do request rodam mesmo assim.
- CMD
INVALID_ARGSUm argumento obrigatório está faltando ou é inválido: email, valor de campo, opção de enum, chave do where, id de lista…
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.