Segments

Update Segment

Rename or change RULE for your segment. Required Access Level: ModifyContacts

put/segments/{name}

Request

  • Base URL
    https://api.elasticemail.com/v4
  • URL
    https://api.elasticemail.com/v4/segments/{name}
  • Auth
    API key in header X-ElasticEmail-ApiKey

Path parameters

namestring string required

string

Example:My Segment 1

Name of your segment.

Request body

Namestring string required

Segment name

Rulestring string required

SQL-like rule to determine which Contacts belong to this Segment. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules

Response

OK

Namestring string

Segment name

Rulestring string

SQL-like rule to determine which Contacts belong to this Segment.

Changes

No recorded changes to this operation across all 2 revisions of this API.