@iterable/cli 0.2.0 → 0.2.2

package/COMMANDS.md

@@ -1,12 +1,12 @@
-# Available Commands (109 commands)
+# Available Commands (109)
 
 All commands follow the pattern: `iterable <category> <command> [options]`
 
 Every command also accepts `--json <data>` for raw JSON input and `--help` for usage details.
 
-## campaigns (14 commands)
+## campaigns (14)
 
-### campaigns abort
+### abort
 
 Abort a campaign that is currently running
 
@@ -18,7 +18,7 @@ iterable campaigns abort <campaignId>
 |--------|------|----------|-------------|
 | `campaignId` | number | **yes** | Campaign ID to abort |
 
-### campaigns activate
+### activate
 
 Activate a triggered campaign
 
@@ -30,7 +30,7 @@ iterable campaigns activate <campaignId>
 |--------|------|----------|-------------|
 | `campaignId` | number | **yes** | Triggered campaign ID to activate |
 
-### campaigns archive
+### archive
 
 Archive one or more campaigns. Scheduled/recurring campaigns will be cancelled, running campaigns will be aborted.
 
@@ -42,7 +42,7 @@ iterable campaigns archive <campaignIds...>
 |--------|------|----------|-------------|
 | `campaignIds` | number[] | **yes** | Campaign IDs to archive |
 
-### campaigns cancel
+### cancel
 
 Cancel a scheduled or recurring campaign
 
@@ -54,7 +54,7 @@ iterable campaigns cancel <campaignId>
 |--------|------|----------|-------------|
 | `campaignId` | number | **yes** | Campaign ID to cancel |
 
-### campaigns create-blast
+### create-blast
 
 Create a new blast campaign from an existing template. The campaign is created without being scheduled. Use schedule to schedule it for delivery.
 
@@ -70,7 +70,7 @@ iterable campaigns create-blast --listIds <listIds...> --name <name> --templateI
 | `--campaignDataFields` | json | no | A JSON object containing campaign-level data fields that are available as merge parameters (for example, {{field}}) during message rendering. These fields are available in templates, data feed URLs, and all other contexts where merge parameters are supported. Campaign-level fields are overridden by user and event data fields of the same name. |
 | `--suppressionListIds` | number[] | no | Array of suppression list IDs |
 
-### campaigns create-triggered
+### create-triggered
 
 Create a new triggered campaign from an existing template. The campaign is created in Ready state and must be activated before it can send.
 
@@ -84,7 +84,7 @@ iterable campaigns create-triggered --name <name> --templateId <templateId>
 | `--templateId` | number | **yes** | The ID of a template to associate with the new campaign |
 | `--campaignDataFields` | json | no | A JSON object containing campaign-level data fields that are available as merge parameters (for example, {{field}}) during message rendering. These fields are available in templates, data feed URLs, and all other contexts where merge parameters are supported. Campaign-level fields are overridden by user and event data fields of the same name. |
 
-### campaigns deactivate
+### deactivate
 
 Deactivate a triggered campaign
 
@@ -96,7 +96,7 @@ iterable campaigns deactivate <campaignId>
 |--------|------|----------|-------------|
 | `campaignId` | number | **yes** | Triggered campaign ID to deactivate |
 
-### campaigns get
+### get
 
 Get detailed information about a specific campaign
 
@@ -108,7 +108,7 @@ iterable campaigns get <id>
 |--------|------|----------|-------------|
 | `id` | number | **yes** | Campaign ID to retrieve |
 
-### campaigns get-children
+### get-children
 
 Get child campaigns generated by a recurring campaign
 
@@ -124,7 +124,7 @@ iterable campaigns get-children <id>
 | `--pageSize` | number | no | Number of results to return per page (defaults to 20, maximum of 1000) |
 | `--sort` | string | no | Field to sort by |
 
-### campaigns get-metrics
+### get-metrics
 
 Get campaign performance metrics
 
@@ -138,19 +138,23 @@ iterable campaigns get-metrics <campaignId>
 | `--endDateTime` | string | no | End date for metrics (YYYY-MM-DD HH:MM:SS format) |
 | `--startDateTime` | string | no | Start date for metrics (YYYY-MM-DD HH:MM:SS format) |
 
-### campaigns list
+### list
 
 Retrieve campaigns
 
+```
+iterable campaigns list
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
-| `--campaignState` | enum[] | no | Filter campaigns by state. Can specify multiple states. Valid states: Draft, Ready, Scheduled, Running, Finished, Starting, Aborted, Recurring, Archived |
+| `--campaignState` | `Draft` \| `Ready` \| `Scheduled` \| `Running` \| `Finished` \| `Starting` \| `Aborted` \| `Recurring` \| `Archived` | no | Filter campaigns by state |
 | `--order` | `asc` \| `desc` | no | Sort direction (asc or desc) |
 | `--page` | number | no | Page number (starting at 1) |
 | `--pageSize` | number | no | Number of results to return per page (defaults to 20, maximum of 1000) |
 | `--sort` | string | no | Field to sort by |
 
-### campaigns schedule
+### schedule
 
 Schedule an existing campaign to be sent at a specific time
 
@@ -164,7 +168,7 @@ iterable campaigns schedule <campaignId> --sendAt <sendAt>
 | `--sendAt` | string | **yes** | When to send (ISO-8601 format, e.g. 2024-12-20T10:15:30Z) |
 | `--recipientTimeZone` | json | no | Recipient timezone configuration (JSON: {defaultTimeZone, startTimeZone}) |
 
-### campaigns send
+### send
 
 Send an existing scheduled campaign immediately
 
@@ -176,7 +180,7 @@ iterable campaigns send <campaignId>
 |--------|------|----------|-------------|
 | `campaignId` | number | **yes** | Campaign ID to send now |
 
-### campaigns trigger
+### trigger
 
 Trigger a campaign to send to specified lists
 
@@ -193,9 +197,9 @@ iterable campaigns trigger --campaignId <campaignId> --listIds <listIds...>
 | `--suppressionListIds` | number[] | no | Lists to suppress |
 
 
-## catalogs (12 commands)
+## catalogs (12)
 
-### catalogs bulk-delete-items
+### bulk-delete-items
 
 Bulk delete catalog items by their IDs
 
@@ -208,7 +212,7 @@ iterable catalogs bulk-delete-items --catalogName <catalogName> --itemIds <itemI
 | `--catalogName` | string | **yes** | Name of the catalog |
 | `--itemIds` | string[] | **yes** | Array of item IDs to delete |
 
-### catalogs create
+### create
 
 Create a new catalog
 
@@ -220,7 +224,7 @@ iterable catalogs create <catalogName>
 |--------|------|----------|-------------|
 | `catalogName` | string | **yes** | Catalog name (alphanumeric and dashes only, max 255 chars) |
 
-### catalogs delete
+### delete
 
 Delete a catalog
 
@@ -232,7 +236,7 @@ iterable catalogs delete <catalogName>
 |--------|------|----------|-------------|
 | `catalogName` | string | **yes** | Name of the catalog to delete |
 
-### catalogs delete-item
+### delete-item
 
 Delete a specific catalog item by ID
 
@@ -245,7 +249,7 @@ iterable catalogs delete-item --catalogName <catalogName> --itemId <itemId>
 | `--catalogName` | string | **yes** | Name of the catalog |
 | `--itemId` | string | **yes** | ID of the catalog item to delete |
 
-### catalogs get-field-mappings
+### get-field-mappings
 
 Get field mappings and data types for a catalog
 
@@ -257,7 +261,7 @@ iterable catalogs get-field-mappings <catalogName>
 |--------|------|----------|-------------|
 | `catalogName` | string | **yes** | Name of the catalog |
 
-### catalogs get-item
+### get-item
 
 Get a specific catalog item by ID
 
@@ -270,7 +274,7 @@ iterable catalogs get-item --catalogName <catalogName> --itemId <itemId>
 | `--catalogName` | string | **yes** | Name of the catalog |
 | `--itemId` | string | **yes** | ID of the catalog item to retrieve |
 
-### catalogs get-items
+### get-items
 
 Get items from a catalog with optional pagination and sorting
 
@@ -286,16 +290,20 @@ iterable catalogs get-items <catalogName>
 | `--pageSize` | number | no | Number of results per page (defaults to 10, max 1000) |
 | `--sortAscending` | boolean | no | Sort results by ascending (defaults to false) |
 
-### catalogs list
+### list
 
 Get list of all catalogs with optional pagination
 
+```
+iterable catalogs list
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--page` | number | no | Page number (starting at 1) |
 | `--pageSize` | number | no | Number of results per page (max 100) |
 
-### catalogs partial-update-item
+### partial-update-item
 
 Partial update (PATCH) a catalog item - updates only specified fields
 
@@ -309,7 +317,7 @@ iterable catalogs partial-update-item --catalogName <catalogName> --itemId <item
 | `--itemId` | string | **yes** | ID of the catalog item |
 | `--update` | json | **yes** | Fields to update |
 
-### catalogs replace-item
+### replace-item
 
 Replace (PUT) a catalog item - replaces the entire item with new value
 
@@ -323,7 +331,7 @@ iterable catalogs replace-item --catalogName <catalogName> --itemId <itemId> --v
 | `--itemId` | string | **yes** | ID of the catalog item |
 | `--value` | json | **yes** | New value for the item |
 
-### catalogs update-field-mappings
+### update-field-mappings
 
 Update catalog field mappings (data types)
 
@@ -336,7 +344,7 @@ iterable catalogs update-field-mappings <catalogName> --mappingsUpdates <mapping
 | `catalogName` | string | **yes** | Name of the catalog |
 | `--mappingsUpdates` | string[] | **yes** | Field mappings to update |
 
-### catalogs update-items
+### update-items
 
 Update catalog items
 
@@ -350,9 +358,9 @@ iterable catalogs update-items <catalogName> --items <items...>
 | `--items` | json[] | **yes** | Catalog items to update |
 
 
-## events (4 commands)
+## events (4)
 
-### events get-by-email
+### get-by-email
 
 Get event history for a user by email address
 
@@ -365,7 +373,7 @@ iterable events get-by-email <email>
 | `email` | string | **yes** | User email address |
 | `--limit` | number | no | Maximum number of events to return |
 
-### events get-by-userid
+### get-by-userid
 
 Get event history for a user by user ID
 
@@ -378,7 +386,7 @@ iterable events get-by-userid <userId>
 | `userId` | string | **yes** | User ID to get events for |
 | `--limit` | number | no | Maximum number of events to return (default: 20) |
 
-### events track
+### track
 
 Track a custom event for a user
 
@@ -398,7 +406,7 @@ iterable events track <eventName>
 | `--templateId` | number | no |  |
 | `--userId` | string | no |  |
 
-### events track-bulk
+### track-bulk
 
 Track multiple events in a single request for better performance
 
@@ -411,9 +419,9 @@ iterable events track-bulk --events <events...>
 | `--events` | json[] | **yes** |  |
 
 
-## experiments (4 commands)
+## experiments (4)
 
-### experiments get
+### get
 
 Get detailed information about a specific experiment by ID
 
@@ -425,10 +433,14 @@ iterable experiments get <experimentId>
 |--------|------|----------|-------------|
 | `experimentId` | number | **yes** | Experiment ID |
 
-### experiments get-metrics
+### get-metrics
 
 Get experiment metrics for A/B testing analysis
 
+```
+iterable experiments get-metrics
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--campaignId` | number[] | no | Campaign IDs whose experiments to export (can specify multiple) |
@@ -436,7 +448,7 @@ Get experiment metrics for A/B testing analysis
 | `--experimentId` | number[] | no | Experiment IDs to export (can specify multiple) |
 | `--startDateTime` | string | no | Export starting from (ISO 8601 format) |
 
-### experiments get-variants
+### get-variants
 
 Get variant content for an experiment, including subject lines, preheaders, HTML source, and plain text
 
@@ -448,10 +460,14 @@ iterable experiments get-variants <experimentId>
 |--------|------|----------|-------------|
 | `experimentId` | number | **yes** | Experiment ID |
 
-### experiments list
+### list
 
 List experiments with optional filtering by campaign, status, and date range
 
+```
+iterable experiments list
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--campaignId` | number | no | Filter by campaign ID |
@@ -462,9 +478,9 @@ List experiments with optional filtering by campaign, status, and date range
 | `--status` | `draft` \| `running` \| `finished` | no | Filter by status (draft, running, finished) |
 
 
-## export (4 commands)
+## export (4)
 
-### export cancel
+### cancel
 
 Cancel a queued or running export job
 
@@ -476,7 +492,7 @@ iterable export cancel <jobId>
 |--------|------|----------|-------------|
 | `jobId` | number | **yes** | The ID of the export job to cancel (returned from startExportJob) |
 
-### export get-files
+### get-files
 
 Get the job status and download URLs for files from a completed export job
 
@@ -489,15 +505,19 @@ iterable export get-files <jobId>
 | `jobId` | number | **yes** | The ID of the export job (returned from startExportJob) |
 | `--startAfter` | string | no | Skip file names up to and including this value. Use for paginating over the files in the export (e.g., 'file-1679086247925.csv') |
 
-### export list-jobs
+### list-jobs
 
 Get a list of recent export jobs for the current project
 
+```
+iterable export list-jobs
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--jobState` | string | no | Filter results to only include jobs in the specified state (enqueued, queued, running, completed, failed, cancelled, cancelling) |
 
-### export start
+### start
 
 Start a data export job that processes as a background job. Use get-files to check status and obtain download links.
 
@@ -517,12 +537,16 @@ iterable export start --dataTypeName <dataTypeName> --outputFormat <outputFormat
 | `--startDateTime` | string | no | Export events occurring or users updated after date and time inclusive |
 
 
-## journeys (2 commands)
+## journeys (2)
 
-### journeys list
+### list
 
 Get journeys (workflows) with optional pagination and state filtering
 
+```
+iterable journeys list
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--order` | `asc` \| `desc` | no | Sort direction (asc or desc) |
@@ -531,7 +555,7 @@ Get journeys (workflows) with optional pagination and state filtering
 | `--sort` | string | no | Field to sort by |
 | `--state` | string[] | no | Filter by journey state (e.g., ['Archived']) |
 
-### journeys trigger
+### trigger
 
 Trigger a journey (workflow) for a user
 
@@ -548,9 +572,9 @@ iterable journeys trigger <workflowId>
 | `--userId` | string | no | User ID (alternative to email) |
 
 
-## lists (8 commands)
+## lists (8)
 
-### lists create
+### create
 
 Create a new user list
 
@@ -563,7 +587,7 @@ iterable lists create <name>
 | `name` | string | **yes** | Name of the list to create |
 | `--description` | string | no | Description of the list |
 
-### lists delete
+### delete
 
 Delete a user list
 
@@ -575,7 +599,7 @@ iterable lists delete <listId>
 |--------|------|----------|-------------|
 | `listId` | number | **yes** | ID of the list to delete |
 
-### lists get-preview-users
+### get-preview-users
 
 Preview users in a list (up to 5000 users)
 
@@ -589,7 +613,7 @@ iterable lists get-preview-users <listId>
 | `--preferUserId` | boolean | no | Return userId instead of email when both exist |
 | `--size` | number | no | Number of users to return (max 5000, default 1000) |
 
-### lists get-size
+### get-size
 
 Get the count of users in a specific list
 
@@ -601,7 +625,7 @@ iterable lists get-size <listId>
 |--------|------|----------|-------------|
 | `listId` | number | **yes** | List ID to get size for |
 
-### lists get-users
+### get-users
 
 Get users in a specific list
 
@@ -614,11 +638,15 @@ iterable lists get-users <listId>
 | `listId` | number | **yes** | List ID to get users from |
 | `--maxResults` | number | no | Maximum number of users to return |
 
-### lists list
+### list
 
 Retrieve user lists
 
-### lists subscribe
+```
+iterable lists list
+```
+
+### subscribe
 
 Subscribe users to a specific list
 
@@ -632,7 +660,7 @@ iterable lists subscribe <listId> --subscribers <subscribers...>
 | `--subscribers` | json[] | **yes** | Array of users to subscribe |
 | `--updateExistingUsersOnly` | boolean | no | Skip operation for unknown userIds/emails when true |
 
-### lists unsubscribe
+### unsubscribe
 
 Unsubscribe users from a specific list
 
@@ -646,12 +674,16 @@ iterable lists unsubscribe <listId> --subscribers <subscribers...>
 | `--subscribers` | json[] | **yes** | Users to unsubscribe |
 
 
-## messaging (16 commands)
+## messaging (16)
 
-### messaging cancel-email
+### cancel-email
 
 Cancel scheduled email for specific user
 
+```
+iterable messaging cancel-email
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--campaignId` | number | no | Campaign ID to cancel |
@@ -659,10 +691,14 @@ Cancel scheduled email for specific user
 | `--scheduledMessageId` | number | no | Scheduled message ID to cancel |
 | `--userId` | string | no | User ID that identifies a user profile |
 
-### messaging cancel-in-app
+### cancel-in-app
 
 Cancel scheduled in-app message for specific user
 
+```
+iterable messaging cancel-in-app
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--campaignId` | number | no | Campaign ID to cancel |
@@ -670,10 +706,14 @@ Cancel scheduled in-app message for specific user
 | `--scheduledMessageId` | number | no | Scheduled message ID to cancel |
 | `--userId` | string | no | User ID that identifies a user profile |
 
-### messaging cancel-push
+### cancel-push
 
 Cancel scheduled push notification for specific user
 
+```
+iterable messaging cancel-push
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--campaignId` | number | no | Campaign ID to cancel |
@@ -681,10 +721,14 @@ Cancel scheduled push notification for specific user
 | `--scheduledMessageId` | number | no | Scheduled message ID to cancel |
 | `--userId` | string | no | User ID that identifies a user profile |
 
-### messaging cancel-sms
+### cancel-sms
 
 Cancel scheduled SMS message for specific user
 
+```
+iterable messaging cancel-sms
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--campaignId` | number | no | Campaign ID to cancel |
@@ -692,10 +736,14 @@ Cancel scheduled SMS message for specific user
 | `--scheduledMessageId` | number | no | Scheduled message ID to cancel |
 | `--userId` | string | no | User ID that identifies a user profile |
 
-### messaging cancel-web-push
+### cancel-web-push
 
 Cancel scheduled web push notification for specific user
 
+```
+iterable messaging cancel-web-push
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--campaignId` | number | no | Campaign ID to cancel |
@@ -703,10 +751,14 @@ Cancel scheduled web push notification for specific user
 | `--scheduledMessageId` | number | no | Scheduled message ID to cancel |
 | `--userId` | string | no | User ID that identifies a user profile |
 
-### messaging cancel-whatsapp
+### cancel-whatsapp
 
 Cancel scheduled WhatsApp message for specific user
 
+```
+iterable messaging cancel-whatsapp
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--campaignId` | number | no | Campaign ID to cancel |
@@ -714,14 +766,22 @@ Cancel scheduled WhatsApp message for specific user
 | `--scheduledMessageId` | number | no | Scheduled message ID to cancel |
 | `--userId` | string | no | User ID that identifies a user profile |
 
-### messaging get-channels
+### get-channels
 
 Get all available communication channels (email, SMS, push, etc.)
 
-### messaging get-embedded-messages
+```
+iterable messaging get-channels
+```
+
+### get-embedded-messages
 
 Get embedded messages for a user, grouped by placement ID
 
+```
+iterable messaging get-embedded-messages
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--currentMessageIds` | string[] | no | IDs of embedded messages already retrieved |
@@ -732,10 +792,14 @@ Get embedded messages for a user, grouped by placement ID
 | `--sdkVersion` | string | no | Iterable SDK version (e.g., 6.5.0) |
 | `--userId` | string | no | User ID (alternative to email) |
 
-### messaging get-in-app-messages
+### get-in-app-messages
 
 Get in-app messages for a user
 
+```
+iterable messaging get-in-app-messages
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--count` | number | no | Number of messages to retrieve |
@@ -743,11 +807,15 @@ Get in-app messages for a user
 | `--platform` | `iOS` \| `Android` \| `Web` | no | Platform filter |
 | `--userId` | string | no | User ID (alternative to email) |
 
-### messaging get-message-types
+### get-message-types
 
 Get all message types within the project for use in templates
 
-### messaging send-email
+```
+iterable messaging get-message-types
+```
+
+### send-email
 
 Send email to user
 
@@ -765,7 +833,7 @@ iterable messaging send-email <campaignId>
 | `--recipientUserId` | string | no | Recipient user ID (alternative to email) |
 | `--sendAt` | string | no | When to send the email (YYYY-MM-DD HH:MM:SS format) |
 
-### messaging send-in-app
+### send-in-app
 
 Send in-app message to user
 
@@ -783,7 +851,7 @@ iterable messaging send-in-app <campaignId>
 | `--recipientUserId` | string | no | Recipient user ID (alternative to email) |
 | `--sendAt` | string | no | When to send (YYYY-MM-DD HH:MM:SS format) |
 
-### messaging send-push
+### send-push
 
 Send push notification to user
 
@@ -801,7 +869,7 @@ iterable messaging send-push <campaignId>
 | `--recipientUserId` | string | no | Recipient user ID |
 | `--sendAt` | string | no | When to send (YYYY-MM-DD HH:MM:SS format) |
 
-### messaging send-sms
+### send-sms
 
 Send SMS message to user
 
@@ -820,7 +888,7 @@ iterable messaging send-sms <campaignId>
 | `--recipientUserId` | string | no | Recipient user ID |
 | `--sendAt` | string | no | When to send (YYYY-MM-DD HH:MM:SS format) |
 
-### messaging send-web-push
+### send-web-push
 
 Send web push notification to user
 
@@ -838,7 +906,7 @@ iterable messaging send-web-push <campaignId>
 | `--recipientUserId` | string | no | Recipient user ID |
 | `--sendAt` | string | no | When to send (YYYY-MM-DD HH:MM:SS format) |
 
-### messaging send-whatsapp
+### send-whatsapp
 
 Send WhatsApp message to user
 
@@ -858,9 +926,9 @@ iterable messaging send-whatsapp <campaignId>
 | `--sendAt` | string | no | When to send (YYYY-MM-DD HH:MM:SS format) |
 
 
-## snippets (5 commands)
+## snippets (5)
 
-### snippets create
+### create
 
 Create a new snippet with Handlebars templating support
 
@@ -876,7 +944,7 @@ iterable snippets create --content <content> --name <name>
 | `--description` | string | no | Description of the snippet |
 | `--variables` | string[] | no | A list of variable names used in the content with a Handlebars expression such as {{#if (eq myVariable "someValue")}}. Variable names are case-sensitive and should be simple identifiers (letters, numbers, underscores). To learn more about using variables in Snippets, see Customizing Snippets with Variables. |
 
-### snippets delete
+### delete
 
 Delete a snippet by ID (numeric) or name (string)
 
@@ -888,7 +956,7 @@ iterable snippets delete <identifier>
 |--------|------|----------|-------------|
 | `identifier` | string | **yes** | Snippet ID (numeric) or name (string). Numeric identifiers are treated as IDs, string identifiers as names |
 
-### snippets get
+### get
 
 Get a snippet by ID (numeric) or name (string)
 
@@ -900,11 +968,15 @@ iterable snippets get <identifier>
 |--------|------|----------|-------------|
 | `identifier` | string | **yes** | Snippet ID (numeric) or name (string). Numeric identifiers are treated as IDs, string identifiers as names |
 
-### snippets list
+### list
 
 Get all snippets for the current project
 
-### snippets update
+```
+iterable snippets list
+```
+
+### update
 
 Update a snippet by ID (numeric) or name (string)
 
@@ -921,9 +993,9 @@ iterable snippets update --content <content> --identifier <identifier>
 | `--variables` | string[] | no | List of variable names used in the content with a Handlebars expression such as {{myField}}. Variable names are case-sensitive and should be simple identifiers (letters, numbers, underscores). To learn more about using Handlebars in Snippets, see Customizing Snippets with Variables. |
 
 
-## subscriptions (5 commands)
+## subscriptions (5)
 
-### subscriptions bulk-update
+### bulk-update
 
 Subscribe or unsubscribe multiple users to/from a subscription group
 
@@ -933,13 +1005,13 @@ iterable subscriptions bulk-update --action <action> --subscriptionGroup <subscr
 
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
-| `--action` | `subscribe` \| `unsubscribe` | **yes** | Action to perform: subscribe or unsubscribe |
+| `--action` | `subscribe` \| `unsubscribe` | **yes** | Action to perform |
 | `--subscriptionGroup` | `emailList` \| `messageType` \| `messageChannel` | **yes** | Type of subscription group |
 | `--subscriptionGroupId` | number | **yes** | Subscription Group Id |
 | `--users` | string[] | no | Users to subscribe/unsubscribe, identified by email |
 | `--usersByUserId` | string[] | no | Users to subscribe/unsubscribe, identified by userId |
 
-### subscriptions subscribe-by-email
+### subscribe-by-email
 
 Subscribe a user to a subscription group by email
 
@@ -953,7 +1025,7 @@ iterable subscriptions subscribe-by-email --subscriptionGroup <subscriptionGroup
 | `--subscriptionGroupId` | number | **yes** | Subscription Group Id |
 | `--userEmail` | string | **yes** | User's email address |
 
-### subscriptions subscribe-by-userid
+### subscribe-by-userid
 
 Subscribe a user to a subscription group by userId
 
@@ -967,7 +1039,7 @@ iterable subscriptions subscribe-by-userid --subscriptionGroup <subscriptionGrou
 | `--subscriptionGroupId` | number | **yes** | Subscription Group Id |
 | `--userId` | string | **yes** | User's userId |
 
-### subscriptions unsubscribe-by-email
+### unsubscribe-by-email
 
 Unsubscribe a user from a subscription group by email
 
@@ -981,7 +1053,7 @@ iterable subscriptions unsubscribe-by-email --subscriptionGroup <subscriptionGro
 | `--subscriptionGroupId` | number | **yes** | Subscription Group Id |
 | `--userEmail` | string | **yes** | User's email address |
 
-### subscriptions unsubscribe-by-userid
+### unsubscribe-by-userid
 
 Unsubscribe a user from a subscription group by userId
 
@@ -996,9 +1068,9 @@ iterable subscriptions unsubscribe-by-userid --subscriptionGroup <subscriptionGr
 | `--userId` | string | **yes** | User's userId |
 
 
-## templates (21 commands)
+## templates (21)
 
-### templates delete
+### delete
 
 Delete one or more templates by ID
 
@@ -1010,7 +1082,7 @@ iterable templates delete <ids...>
 |--------|------|----------|-------------|
 | `ids` | number[] | **yes** | IDs of templates to delete |
 
-### templates get-by-client-id
+### get-by-client-id
 
 Get template by client template ID
 
@@ -1022,7 +1094,7 @@ iterable templates get-by-client-id <clientTemplateId>
 |--------|------|----------|-------------|
 | `clientTemplateId` | string | **yes** | Client template ID to look up template by |
 
-### templates get-email
+### get-email
 
 Get details for specific email template by ID
 
@@ -1035,7 +1107,7 @@ iterable templates get-email <templateId>
 | `templateId` | number | **yes** | Template ID to retrieve |
 | `--locale` | string | no | Locale of content to get |
 
-### templates get-inapp
+### get-inapp
 
 Get details for specific in-app message template by ID
 
@@ -1048,7 +1120,7 @@ iterable templates get-inapp <templateId>
 | `templateId` | number | **yes** | Template ID to retrieve |
 | `--locale` | string | no | Locale of content to get |
 
-### templates get-push
+### get-push
 
 Get details for specific push notification template by ID
 
@@ -1061,7 +1133,7 @@ iterable templates get-push <templateId>
 | `templateId` | number | **yes** | Template ID to retrieve |
 | `--locale` | string | no | Locale of content to get |
 
-### templates get-sms
+### get-sms
 
 Get details for specific SMS template by ID
 
@@ -1074,10 +1146,14 @@ iterable templates get-sms <templateId>
 | `templateId` | number | **yes** | Template ID to retrieve |
 | `--locale` | string | no | Locale of content to get |
 
-### templates list
+### list
 
 Retrieve templates
 
+```
+iterable templates list
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--endDateTime` | string | no | Get templates created before this date time (yyyy-MM-dd HH:mm:ss [ZZ]) |
@@ -1089,7 +1165,7 @@ Retrieve templates
 | `--startDateTime` | string | no | Get templates created at or after this date time (yyyy-MM-dd HH:mm:ss [ZZ]) |
 | `--templateType` | `Base` \| `Blast` \| `Triggered` \| `Workflow` | no | Filter by template type |
 
-### templates preview-email
+### preview-email
 
 Preview email template with custom data. Returns fully rendered HTML.
 
@@ -1103,7 +1179,7 @@ iterable templates preview-email <templateId>
 | `--data` | json | no | Data to use for template rendering (JSON: {dataFields, dataFeed, fetchDataFeeds}) |
 | `--locale` | string | no | Locale of content to get |
 
-### templates preview-inapp
+### preview-inapp
 
 Preview in-app message template with custom data. Returns fully rendered HTML.
 
@@ -1117,7 +1193,7 @@ iterable templates preview-inapp <templateId>
 | `--data` | json | no | Data to use for template rendering (JSON: {dataFields, dataFeed, fetchDataFeeds}) |
 | `--locale` | string | no | Locale of content to get |
 
-### templates proof-email
+### proof-email
 
 Send a proof of an email template to a specific user
 
@@ -1133,7 +1209,7 @@ iterable templates proof-email <templateId>
 | `--recipientEmail` | string | no | An email address that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. |
 | `--recipientUserId` | string | no | A user ID that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. |
 
-### templates proof-inapp
+### proof-inapp
 
 Send a proof of an in-app message template to a specific user
 
@@ -1149,7 +1225,7 @@ iterable templates proof-inapp <templateId>
 | `--recipientEmail` | string | no | An email address that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. |
 | `--recipientUserId` | string | no | A user ID that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. |
 
-### templates proof-push
+### proof-push
 
 Send a proof of a push notification template to a specific user
 
@@ -1165,7 +1241,7 @@ iterable templates proof-push <templateId>
 | `--recipientEmail` | string | no | An email address that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. |
 | `--recipientUserId` | string | no | A user ID that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. |
 
-### templates proof-sms
+### proof-sms
 
 Send a proof of an SMS template to a specific user
 
@@ -1181,7 +1257,7 @@ iterable templates proof-sms <templateId>
 | `--recipientEmail` | string | no | An email address that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. |
 | `--recipientUserId` | string | no | A user ID that identifies a user profile in Iterable. Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users. |
 
-### templates update-email
+### update-email
 
 Update existing email template by templateId
 
@@ -1204,7 +1280,7 @@ iterable templates update-email <templateId>
 | `--plainText` | string | no | Plain text content |
 | `--subject` | string | no | Email subject |
 
-### templates update-inapp
+### update-inapp
 
 Update existing in-app message template by templateId
 
@@ -1223,7 +1299,7 @@ iterable templates update-inapp <templateId>
 | `--messageTypeId` | number | no | Message type ID |
 | `--name` | string | no | Template name |
 
-### templates update-push
+### update-push
 
 Update existing push notification template by templateId
 
@@ -1246,7 +1322,7 @@ iterable templates update-push <templateId>
 | `--sound` | string | no | Sound file |
 | `--title` | string | no | Push notification title |
 
-### templates update-sms
+### update-sms
 
 Update existing SMS template by templateId
 
@@ -1265,7 +1341,7 @@ iterable templates update-sms <templateId>
 | `--messageTypeId` | number | no | Message type ID |
 | `--name` | string | no | Template name |
 
-### templates upsert-email
+### upsert-email
 
 Create or update email template. If a template with the specified clientTemplateId exists, it will be updated; otherwise, a new template will be created.
 
@@ -1288,7 +1364,7 @@ iterable templates upsert-email <clientTemplateId>
 | `--plainText` | string | no | Plain text content |
 | `--subject` | string | no | Email subject |
 
-### templates upsert-inapp
+### upsert-inapp
 
 Create or update in-app message template. If a template with the specified clientTemplateId exists, it will be updated; otherwise, a new template will be created.
 
@@ -1307,7 +1383,7 @@ iterable templates upsert-inapp <clientTemplateId>
 | `--messageTypeId` | number | no | Message type ID |
 | `--name` | string | no | Template name |
 
-### templates upsert-push
+### upsert-push
 
 Create or update push notification template. If a template with the specified clientTemplateId exists, it will be updated; otherwise, a new template will be created.
 
@@ -1330,7 +1406,7 @@ iterable templates upsert-push <clientTemplateId>
 | `--sound` | string | no | Sound file |
 | `--title` | string | no | Push notification title |
 
-### templates upsert-sms
+### upsert-sms
 
 Create or update SMS template. If a template with the specified clientTemplateId exists, it will be updated; otherwise, a new template will be created.
 
@@ -1350,9 +1426,9 @@ iterable templates upsert-sms <clientTemplateId>
 | `--name` | string | no | Template name |
 
 
-## users (12 commands)
+## users (12)
 
-### users bulk-update
+### bulk-update
 
 Update multiple users at once
 
@@ -1364,7 +1440,7 @@ iterable users bulk-update --users <users...>
 |--------|------|----------|-------------|
 | `--users` | json[] | **yes** | Array of users to update |
 
-### users delete *(alias)*
+### delete *(alias)*
 
 Delete a user by email or userId (auto-detected)
 
@@ -1376,7 +1452,7 @@ iterable users delete <identifier>
 |--------|------|----------|-------------|
 | `identifier` | string | **yes** | Email address or userId |
 
-### users delete-by-email
+### delete-by-email
 
 Delete a user by email address (asynchronous)
 
@@ -1388,7 +1464,7 @@ iterable users delete-by-email <email>
 |--------|------|----------|-------------|
 | `email` | string | **yes** | Email address of the user to delete |
 
-### users delete-by-userid
+### delete-by-userid
 
 Delete a user by user ID (asynchronous, deletes all users with same userId)
 
@@ -1400,7 +1476,7 @@ iterable users delete-by-userid <userId>
 |--------|------|----------|-------------|
 | `userId` | string | **yes** | User ID of the user to delete |
 
-### users get *(alias)*
+### get *(alias)*
 
 Get a user by email or userId (auto-detected)
 
@@ -1412,7 +1488,7 @@ iterable users get <identifier>
 |--------|------|----------|-------------|
 | `identifier` | string | **yes** | Email address or userId |
 
-### users get-by-email
+### get-by-email
 
 Get user profile information by email address
 
@@ -1424,7 +1500,7 @@ iterable users get-by-email <email>
 |--------|------|----------|-------------|
 | `email` | string | **yes** | Email address of the user to retrieve |
 
-### users get-by-userid
+### get-by-userid
 
 Get user profile information by user ID
 
@@ -1436,14 +1512,22 @@ iterable users get-by-userid <userId>
 |--------|------|----------|-------------|
 | `userId` | string | **yes** | User ID to retrieve |
 
-### users get-fields
+### get-fields
 
 Get all user profile field definitions and their types
 
-### users get-sent-messages
+```
+iterable users get-fields
+```
+
+### get-sent-messages
 
 Get messages sent to a specific user with optional filtering
 
+```
+iterable users get-sent-messages
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--campaignIds` | number[] | no | Only include messages from these campaigns |
@@ -1455,10 +1539,14 @@ Get messages sent to a specific user with optional filtering
 | `--startDateTime` | string | no | Start date time (yyyy-MM-dd HH:mm:ss ZZ) |
 | `--userId` | string | no | User ID (alternative to email) |
 
-### users update
+### update
 
 Update user profile information (accepts email OR userId)
 
+```
+iterable users update
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--createNewFields` | boolean | no | Whether new fields should be ingested and added to the schema |
@@ -1468,7 +1556,7 @@ Update user profile information (accepts email OR userId)
 | `--preferUserId` | boolean | no | Whether to create new user if userId doesn't exist (email-based projects only) |
 | `--userId` | string | no | User ID (alternative to email) |
 
-### users update-email
+### update-email
 
 Update a user's email address (only for email-based projects)
 
@@ -1482,10 +1570,14 @@ iterable users update-email <newEmail>
 | `--currentEmail` | string | no | An email address that identifies a user profile in Iterable. Provide a currentEmail or a currentUserId (but not both), depending on how your project identifies users. |
 | `--currentUserId` | string | no | A user ID that identifies a user profile in Iterable. Provide a currentEmail or a currentUserId (but not both), depending on how your project identifies users. |
 
-### users update-subscriptions
+### update-subscriptions
 
 Update user subscriptions (overwrites existing data for any non-null fields specified)
 
+```
+iterable users update-subscriptions
+```
+
 | Option | Type | Required | Description |
 |--------|------|----------|-------------|
 | `--campaignId` | number | no | Campaign to attribute unsubscribes |
@@ -1499,13 +1591,17 @@ Update user subscriptions (overwrites existing data for any non-null fields spec
 | `--validateChannelAlignment` | boolean | no | Defaults to true (validation enabled). When false, allows subscribing users to message types that belong to unsubscribed channels. By default, Iterable validates that subscribed message types belong to subscribed channels. Setting this to false bypasses this validation, allowing you to save message type preferences even when the parent channel is unsubscribed. Users won't receive messages from these types while the channel remains unsubscribed, but their preferences are preserved for when the channel becomes subscribed. |
 
 
-## webhooks (2 commands)
+## webhooks (2)
 
-### webhooks list
+### list
 
 Get all webhooks for the project
 
-### webhooks update
+```
+iterable webhooks list
+```
+
+### update
 
 Update a webhook configuration
 
@@ -1525,7 +1621,7 @@ iterable webhooks update <webhookId>
 
 Manage stored API keys.
 
-### keys list
+### list
 
 View all stored API keys
 
@@ -1533,7 +1629,7 @@ View all stored API keys
 iterable keys list
 ```
 
-### keys add
+### add
 
 Add a new API key
 
@@ -1541,7 +1637,7 @@ Add a new API key
 iterable keys add
 ```
 
-### keys update <name-or-id>
+### update <name-or-id>
 
 Update an existing key's settings
 
@@ -1549,7 +1645,7 @@ Update an existing key's settings
 iterable keys update <name-or-id>
 ```
 
-### keys activate <name-or-id>
+### activate <name-or-id>
 
 Switch to a different key
 
@@ -1557,7 +1653,7 @@ Switch to a different key
 iterable keys activate <name-or-id>
 ```
 
-### keys deactivate
+### deactivate
 
 Deactivate the current key
 
@@ -1565,7 +1661,7 @@ Deactivate the current key
 iterable keys deactivate
 ```
 
-### keys delete <name-or-id>
+### delete <name-or-id>
 
 Remove a key by ID or name
 
@@ -1573,7 +1669,7 @@ Remove a key by ID or name
 iterable keys delete <name-or-id>
 ```
 
-### keys validate
+### validate
 
 Test the API connection