Magidoc

CreateGroupInput
Input Object

Fields

#

audienceId

String !
Non-null

The unique identifier of the audience (subscriber list) to create the group in.

campaignId

String

The unique identifier of the campaign associated with this group, if applicable. This is for system use only.

criteria

ConditionGroupInput

The criteria for dynamic group (segment) membership. Only applicable when IsDynamic is true.

description

String

Optional description of the group. Max length: 255

isCustom

Boolean

Whether the segment is system generated from a specific report or other area. System use only.

isDynamic

Boolean !
Non-null

Whether the group is a segment, dynamically calculated based on criteria. Defaults to false for static groups.

isPublic

Boolean !
Non-null

Whether the group is visible to the public (e.g., on signup forms). Defaults to false.

name

String !
Non-null

The name of the group. Must be unique within the audience. Max length: 100

Usages

#

References

#

  • Argument input of field createAudienceGroup from type Mutation