agent-audiences

Agent Patch Segment

Edit a segment. Passing a definition re-evaluates it, so the same address-predicate guard applies as on preview.

Rewriting the definition of a segment a published journey or a scheduled send already reads is a way to widen who gets mailed, so that case asks for a confirmation.

patch/api/agent/v1/segments/{segment_id}

Request

  • Base URL: https://app.sentientmail.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.sentientmail.com/api/agent/v1/segments/{segment_id}
  • Auth: none declared

Path parameters

segment_idstring uuid required

Headers

X-Confirmation-Idstring nullable
authorizationstring nullable
X-API-Keystring nullable
X-Business-Unitstring nullable

Request body

namestring nullable
descriptionstring nullable
external_keystring nullable
definitionobject nullable

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.