Receive Emails: Newsletters
Get Unsubscribe Options
Can you unsubscribe from the list that sent this email, how, and did you already?
https://g.sendcorex.com/v1command: get_unsubscribe_optionsArguments
idstringrequiredAn email you received.
Quick start
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1',
{
commands: [
{
command: "get_unsubscribe_options",
args: {
id: "Vj0xQUJDMTIz"
}
}
]
},
{ 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_unsubscribe_options",
"id": "0",
"type": "SUCCESS",
"data": {
"can_unsubscribe": true,
"method": "one_click",
"one_click": true,
"http": "https://shop.com/u/abc",
"mailto": "mailto:unsub@shop.com?subject=unsubscribe",
"list_id": "Shop News <news.shop.com>",
"list_key": "news.shop.com",
"from_email": "news@shop.com"
}
}
]
}Response fields
methodone_click,mailtoorhttp— whatunsubscribewill use.list_keyThe List-Id when the email has one, otherwise the sender. The same newsletter from another address is the same list.
statusPresent when you already asked:
done,pendingorfailed.
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_ARGSA required argument is missing or invalid.
- CMD
NOT_FOUNDThe message, thread or folder does not exist for this token.
- CMD
INTERNALServer error. The detail is only written to the server log.