Segments

Create a segment

Create a segment — a named group of contacts you can target when sending a campaign. Once created, add contacts with Add a member and target it from Create a campaign. A dynamic segment's filter is evaluated live: a condition on a custom field uses the field's default_value for any contact that has no value, and is_set / is_not_set check whether the contact itself has a value. To let recipients opt out of a category of mail instead, see Create a topic. Requires the segments:write capability.

post/segments

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/segments
  • Auth: HTTP bearer

Request body

namestring required
descriptionstring
type'static' | 'dynamic'
filterSchema0 (unresolved $ref)

Response

Created.

object'segment' required
idstring required
namestring required
descriptionstring nullable required
type'static' | 'dynamic' required
filterSchema0 required(unresolved $ref)
created_atstring required
updated_atstring required

Changes

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