nextmail segments
Every command in this namespace, with its arguments, flags and examples.
Commands
Saved conditions on contacts, such as opened in the last 90 days or a custom field, that narrow a broadcast to the people who match: save, change and delete them, and count who they match.
Every command here also takes the global flags, such as --json, --profile and --dry-run. See the global flags
nextmail segments list
List the saved segments
lsUsage
nextmail segments list [flags]
Resolves every saved segment of the workspace as a plain array, newest first, each with its name, its description and its conditions. A workspace keeps at most 100, so the list is never paged.
A segment holds no contacts of its own. Who matches is worked out each time it is read, so use preview to count the matches and pass a segment id as segmentId to broadcasts.send to narrow a broadcast with it.
Examples
nextmail segments listnextmail segments list --jsonAlso available in
- API
GET /segments- TypeScript
nextmail.segments.list()- Python
segments.list()- Ruby
segments.list- PHP
segments->list- Go
Segments.List- Java
segments().list- C#
Segments.ListAsync
nextmail segments get
Get one segment
showviewUsage
nextmail segments get <id> [flags]
Fetches one saved segment by its id, with match and every condition in definition. The conditions come back as they were saved, so the object can be edited and passed to update or preview as it is.
Arguments
<id>RequiredSegment id such as
seg_5d2a9c7e1b4f08a36c1e9b42.
Examples
nextmail segments get seg_5d2a9c7e1b4f08a36c1e9b42nextmail segments get seg_5d2a9c7e1b4f08a36c1e9b42 --jsonAlso available in
- API
GET /segments/{id}- TypeScript
nextmail.segments.get()- Python
segments.get()- Ruby
segments.get- PHP
segments->get- Go
Segments.Get- Java
segments().get- C#
Segments.GetAsync
nextmail segments create
Save a segment
newaddUsage
nextmail segments create --name <value> --definition <json|@file|-> [flags] nextmail segments create --data <json|@file|-> [flags]
Saves a set of conditions under a name. definition.match is all (the default) when a contact has to meet every condition, or any when one is enough, and definition.conditions holds 1 to 20 of them.
Each condition names a field and an operator. email takes is, is_not, contains, not_contains and ends_with, and name takes those but ends_with, plus is_set and is_not_set. source takes is and is_not with how the contact was added. created, opened, clicked and engaged take within_days and not_within_days with days: when the contact was added, the last time they opened or clicked a tracked email from the workspace, and the later of those two. audience takes in and not_in with audienceId, and counts only subscribed members. event takes within_days and not_within_days with event, a name sent with events.send, and days. attribute takes key, the name of a custom field on the contact, with the operators name takes. Text is compared without regard to case.
Nothing is sent and no contact changes. A segment is used by passing its id as segmentId to broadcasts.send.
Flags
--name <value>What the segment is called, 1 to 120 characters. Required, here or in
--data.--description <value>A longer note, up to 500 characters.
--definition <json|@file|->{ match?: 'all' | 'any', conditions: Array<SegmentCondition> }with 1 to 20 conditions. JSON shaped asSegmentDefinitionInput, inline or from a file with @path. Required, here or in--data.--data <json|@file|->The whole
bodyas JSON, inline, from a file with @path, or - for standard input. Flags override its keys.
Examples
nextmail segments create --name 'Opened in the last 90 days' --definition @definition.jsonnextmail segments create --data @segments.jsonAlso available in
nextmail segments update
Change a segment
editUsage
nextmail segments update <id> [flags]
A partial update: a field you leave out keeps what it holds. Sending definition replaces match and every condition at once, and description: null takes the description away.
A broadcast already sent or scheduled keeps the conditions it was given, so a change here only reaches the broadcasts sent after it.
Arguments
<id>RequiredThe
seg_id of the segment.
Flags
--name <value>A new name, 1 to 120 characters.
--description <value>A new note. Null takes it away.
--definition <json|@file|->New conditions, replacing the old ones. JSON shaped as
SegmentDefinitionInput, inline or from a file with @path.--data <json|@file|->The whole
patchas JSON, inline, from a file with @path, or - for standard input. Flags override its keys.
Examples
nextmail segments update seg_5d2a9c7e1b4f08a36c1e9b42 --name 'Opened in the last 30 days'nextmail segments update seg_5d2a9c7e1b4f08a36c1e9b42 --name 'Opened in the last 30 days' --jsonAlso available in
nextmail segments delete
Delete a segment
rmdelremoveUsage
nextmail segments delete <id> [flags]
Deletes the saved segment. No contact is touched, and a broadcast already sent or scheduled keeps the conditions it was given.
A draft that still names the segment in segmentId is refused with 404 segment_not_found when it is sent, until it names another segment or none.
Arguments
<id>RequiredThe
seg_id of the segment.
Examples
nextmail segments delete seg_5d2a9c7e1b4f08a36c1e9b42nextmail segments delete seg_5d2a9c7e1b4f08a36c1e9b42 --yesAlso available in
nextmail segments preview
Count the contacts a segment matches
Usage
nextmail segments preview --definition <json|@file|-> [flags] nextmail segments preview --data <json|@file|-> [flags]
Counts the contacts a set of conditions matches now and returns up to 10 of them, without saving or sending anything. Pass the definition of a saved segment to count it, or new conditions to try them first.
With --audience-ids, only the subscribed members of those audiences count, which is the number a broadcast to them with this segment would start from before unsubscribes and suppressions are taken out. broadcasts.preview with segmentId gives that final number.
Flags
--definition <json|@file|->The conditions to count, as
createtakes them. JSON shaped asSegmentDefinitionInput, inline or from a file with @path. Required, here or in--data.--audience-ids <a,b>RepeatableUp to 10 audiences. Only their subscribed members count. Left out, every contact of the workspace counts.
--data <json|@file|->The whole
bodyas JSON, inline, from a file with @path, or - for standard input. Flags override its keys.
Examples
nextmail segments preview --definition @definition.jsonnextmail segments preview --definition @definition.json --audience-ids aud_4c1b8e2a7d9f05c36b4e8a71nextmail segments preview --data @segments.json
Google Workspace
Fastmail