createDynamicSegment

Required scopes: segments_write

Arguments

CreateDynamicSegmentInput!

required

Name and conditions for the new segment.

Show fields

JSON!

required

Condition tree matching segmentConditionCatalog.conditionsJsonSchema.

String!

required

The merchant-facing name of the segment.

Returns

Segment!

required

A group of customers that campaigns and automations send to.

Show fields

JSON

Dynamic segment condition tree. Null for static and persona segments.

DateTime

When the member counts were last recalculated. They are not live.

DateTime!

required

When the segment was created.

String

The merchant’s description of who this segment is for.

Int

Members subscribed to email marketing as of countsRefreshedAt.

ID!

required

The id of this segment.

String!

required

The segment’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.

Int

Customers in the segment as of countsRefreshedAt. Null until it has first been counted.

String!

required

The merchant-facing name of the segment.

Int

Members subscribed to SMS marketing as of countsRefreshedAt.

SegmentType!

required

How membership of this segment is determined.

DateTime!

required

When the segment was last updated.

Example

mutation {
  createDynamicSegment(input: { ... }) {
    conditions
    countsRefreshedAt
    createdAt
    description
    emailSubscriberCount
    id
    legacyId
    memberCount
    # ...
  }
}

Getting Started

Reference

createDynamicSegment

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example