provider Contacts API - Segments DELETE /contactdb/segments/{segment_id}
@utdk/sendgrid /contactdb/segments/{segment_id}
Delete a segment
**This endpoint allows you to delete a segment from your recipients database.** You also have the option to delete all the contacts from your Marketing Campaigns recipient database who were in this segment.
segment_id path required
string
delete_contacts query
True to delete all contacts matching the segment in addition to deleting the segment
boolean
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

deleteContactdbSegmentsSegmentId
DELETE/contactdb/segments/{segment_id}
**This endpoint allows you to delete a segment from your recipients database.** You also have the option to delete all the contacts from your Marketing Campaigns recipient database who were in this segment.

Parameters

required

True to delete all contacts matching the segment in addition to deleting the segment

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.deleteContactdbSegmentsSegmentId({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})