Receive Emails: Contacts & audience
Get Audience
Checks an audience before sending: how many people and the first 30. Read only.
https://g.sendcorex.com/v1command: get_audiencePeople who unsubscribed are always left out.
Available on paid plans.
Arguments
segmentstringrequiredsubscribed,opened,clicked,both,seg:<segment_id>ormsg:<message_uid>:opened|clicked|not_opened.
Quick start
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1',
{
commands: [
{
command: "get_audience",
args: {
segment: "opened"
}
}
]
},
{ 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);Response
{
"type": "SUCCESS",
"results": [
{
"command": "get_audience",
"id": "0",
"type": "SUCCESS",
"data": {
"segment": "opened",
"emails": [
"ana@empresa.com"
],
"total": 1240
}
}
]
}Response fields
segmentThe audience you asked for.
emailsThe first 30 addresses.
totalHow many people will receive it.
Errors
HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.
- 401
TOKEN_EXPIREDThe access token has expired. Call Refresh Token and repeat the request.
- 401
INVALID_TOKENThe token is malformed, unknown or revoked.
- 429
RATE_LIMITEDMore than 15 requests/s or 15 in flight for the same IP + mailbox. Wait the number of seconds in Retry-After.
- CMD
INVALID_AUDIENCEThe audience is not valid: unknown group, a segment of another mailbox or a message this mailbox didn’t send.
- CMD
PAID_PLAN_REQUIREDMore than one address in `to` needs a paid plan.
- CMD
INTERNALServer error. The detail is only written to the server log.