Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Leave a segment

DELETE/contacts/{id}/segments/{segmentId}
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
idstringrequired
min length 1
segmentIdstring<uuid>required
Responses
200

Contact removed from the segment

idstring<uuid>required
audienceIdstring<uuid>required
deletedbooleanrequired
Allowed:true
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X DELETE 'https://api.billionsend.com/contacts/string/segments/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "audienceId": "9a7801af-334b-4ef5-a6a4-a23abb92f9dd",
  "deleted": true
}

Was this page helpful?