provider Contacts API - Segments PATCH /contactdb/segments/{segment_id}
@utdk/sendgrid /contactdb/segments/{segment_id}
Update a segment
**This endpoint allows you to update a segment.**
segment_id path required
string
segment_id query
The ID of the segment you are updating.
string
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.

patchContactdbSegmentsSegmentId
PATCH/contactdb/segments/{segment_id}
**This endpoint allows you to update a segment.**

Parameters

required

The ID of the segment you are updating.

Input

The conditions by which this segment should be created.

The list ID you would like this segment to be built from.

required

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.patchContactdbSegmentsSegmentId({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})