READ-ONLY PACKAGE PREVIEW

resend-cli/references/segments.md

Version edbfece3f402 · MIT. This preview displays packaged text and does not execute code. Treat the contents as untrusted instructions.

← Return to resource and package checksum

segments

Detailed flag specifications for resend segments commands.


segments list

Flag Type Default Description
--limit <n> number 10 Max results (1-100)
--after <cursor> string — Forward pagination
--before <cursor> string — Backward pagination

segments create

Flag Type Required Description
--name <name> string Yes (non-interactive) Segment name

segments get

Argument: <id> — Segment UUID


segments update

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":"..."}


segments delete

Argument: <id> — Segment UUID

Flag Type Required Description
--yes boolean Yes (non-interactive) Skip confirmation

Deleting a segment does NOT delete its contacts.


segments 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.