Skip to documentation

API · Segments

Delete Segment

Delete a segment while keeping its contacts (requires full access). Membership cleanup may finish after the response.

DELETE/segments/{id}Full access

Request parameters

ParameterTypeDescription
id
path · required
stringOpaque resource id.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash
curl -X DELETE "$OPENSEND_BASE_URL/segments/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json
{
  "object": "segment",
  "id": "YOUR_ID",
  "deleted": true
}

Behavior and errors

Deleting a segment preserves contacts and cleans memberships in batches.

Use a full-access credential. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.