Setting the file. One moment.
Subchapter 4.12
references/segments.mdMarkdown2 KBView on GitHub
--limit <n> | number | 10 | Max results (1-100) |
--after <cursor> | string | — | Forward pagination |
--before <cursor> | string | — | Backward pagination |
| Flag | Type | Required | Description |
|---|---|---|---|
--name <name> | string | Yes (non-interactive) | Segment name |
Argument: <id> — Segment UUID
Rename a segment.
Argument: [id] — Segment UUID (interactive picker if omitted)
| Flag | Type | Required | Description |
|---|---|---|---|
--name <name> | string | Yes (non-interactive) | New segment name |
Output: {"object":"segment","id":"..."}
Argument: <id> — Segment UUID
| Flag | Type | Required | Description |
|---|---|---|---|
--yes | boolean | Yes (non-interactive) | Skip confirmation |
Deleting a segment does NOT delete its contacts.
Argument: [segmentId] — Segment UUID (interactive picker if omitted)
| Flag | Type | Default | Description |
|---|---|---|---|
--limit <n> | number | 10 | Max results (1-100) |
--after <cursor> | string | — | Forward pagination |
--before <cursor> | string | — | Backward pagination |
Lists contacts belonging to a segment. Uses resend.contacts.list({ segmentId }) which maps to GET /segments/:segment_id/contacts.