Segments

Add Segment

Add a new segment, based on specified RULE. Required Access Level: ModifyContacts

post/segments

Request

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

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

Created

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.