Contacts: Segments
Delete Segment
Delete a saved segment. Only the saved query goes away; no contact is touched.
https://g.sendcorex.com/v1/contactscommand: delete_segmentNeeds the contact:delete scope on your API key.
Arguments
segment_idstringrequiredThe segment to delete.
e.g.
"engaged-vips"
Quick start
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "delete_segment",
args: {
segment_id: "engaged-vips"
}
}
]
},
{ 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);Response
{
"type": "SUCCESS",
"results": [
{
"command": "delete_segment",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"deleted": true
}
}
]
}Response fields
deletedtruewhen the segment was deleted.
Errors
HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.
- 401
INVALID_API_KEYThe API key does not exist, was revoked or was disabled in the dashboard.
- 429
RATE_LIMITEDMore than 15 requests/s or 15 in flight for the same IP + API key. Wait the number of seconds in Retry-After.
- CMD
MISSING_SCOPEThe API key does not have the scope this command needs. The other commands in the request still run.
- CMD
INVALID_ARGSA required argument is missing or invalid: email, field value, enum option, where key, list id…
- CMD
NOT_FOUNDThe contact, list, field or segment does not exist.
- CMD
INTERNALServer error. The detail is only written to the server log.