CRM Groups

Create a CRM Group from a dashboard segment

Build a group from a Creators-tab segment — a GMV tier, an automation_id, and a date window — rather than from raw filter conditions. Use it to turn 'creators in tier L3 reached by automation 812 last month' into a reusable cohort you can target with an automation.

Membership is a snapshot. Members are materialized once at creation and do not update as creators enter or leave the segment. Re-post to refresh.

The window is always bounded. Omit start_date/end_date and the segment resolves over the trailing 28 days rather than the shop's whole history; the maximum span is 365 days. Pass both dates explicitly whenever the segment you have in mind is a specific period.

Creation upserts by name. Reusing an existing group_name in this shop overwrites that group's definition and replaces its members.

Expect fewer creators than the dashboard shows. Only CRM-tracked creators can be grouped, so DM-only and organic creators in the segment resolve to nothing. handles_resolved is what the segment matched; creator_count is what made it into the group. The gap between them is that drop-off — check it before treating the group as the segment.

X-Dry-Run: true reports the segment size and whether it exceeds the group limit, without writing. It cannot show the CRM drop-off: that is only known once the group is built.

post/crm-groups/from-segment

Headers

Idempotency-Keystring nullable
X-Dry-Runstring nullable

Request body

group_namestring required

Name for the new group. Creation upserts by (shop, group_name) — reusing a name overwrites that group's definition and re-materializes its members.

tierstring nullable

GMV tier code to narrow the segment, e.g. 'L3'. Omit for all tiers.

automation_idinteger nullable

Restrict the segment to creators reached by this automation.

start_datestring date nullable

Segment window start (inclusive).

end_datestring date nullable

Segment window end (inclusive).

group_tagsstring[] nullable

Optional tags to attach to the group.

Response

Dry-run result (X-Dry-Run: true). Nothing was written.

dry_runboolean nullable

Changes

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