|
1 | | -# Available Commands (109 commands) |
| 1 | +# Available Commands (109) |
2 | 2 |
|
3 | 3 | All commands follow the pattern: `iterable <category> <command> [options]` |
4 | 4 |
|
5 | 5 | Every command also accepts `--json <data>` for raw JSON input and `--help` for usage details. |
6 | 6 |
|
7 | | -## campaigns (14 commands) |
| 7 | +## campaigns (14) |
8 | 8 |
|
9 | 9 | ### campaigns abort |
10 | 10 |
|
@@ -193,7 +193,7 @@ iterable campaigns trigger --campaignId <campaignId> --listIds <listIds...> |
193 | 193 | | `--suppressionListIds` | number[] | no | Lists to suppress | |
194 | 194 |
|
195 | 195 |
|
196 | | -## catalogs (12 commands) |
| 196 | +## catalogs (12) |
197 | 197 |
|
198 | 198 | ### catalogs bulk-delete-items |
199 | 199 |
|
@@ -350,7 +350,7 @@ iterable catalogs update-items <catalogName> --items <items...> |
350 | 350 | | `--items` | json[] | **yes** | Catalog items to update | |
351 | 351 |
|
352 | 352 |
|
353 | | -## events (4 commands) |
| 353 | +## events (4) |
354 | 354 |
|
355 | 355 | ### events get-by-email |
356 | 356 |
|
@@ -411,7 +411,7 @@ iterable events track-bulk --events <events...> |
411 | 411 | | `--events` | json[] | **yes** | | |
412 | 412 |
|
413 | 413 |
|
414 | | -## experiments (4 commands) |
| 414 | +## experiments (4) |
415 | 415 |
|
416 | 416 | ### experiments get |
417 | 417 |
|
@@ -462,7 +462,7 @@ List experiments with optional filtering by campaign, status, and date range |
462 | 462 | | `--status` | `draft` \| `running` \| `finished` | no | Filter by status (draft, running, finished) | |
463 | 463 |
|
464 | 464 |
|
465 | | -## export (4 commands) |
| 465 | +## export (4) |
466 | 466 |
|
467 | 467 | ### export cancel |
468 | 468 |
|
@@ -517,7 +517,7 @@ iterable export start --dataTypeName <dataTypeName> --outputFormat <outputFormat |
517 | 517 | | `--startDateTime` | string | no | Export events occurring or users updated after date and time inclusive | |
518 | 518 |
|
519 | 519 |
|
520 | | -## journeys (2 commands) |
| 520 | +## journeys (2) |
521 | 521 |
|
522 | 522 | ### journeys list |
523 | 523 |
|
@@ -548,7 +548,7 @@ iterable journeys trigger <workflowId> |
548 | 548 | | `--userId` | string | no | User ID (alternative to email) | |
549 | 549 |
|
550 | 550 |
|
551 | | -## lists (8 commands) |
| 551 | +## lists (8) |
552 | 552 |
|
553 | 553 | ### lists create |
554 | 554 |
|
@@ -646,7 +646,7 @@ iterable lists unsubscribe <listId> --subscribers <subscribers...> |
646 | 646 | | `--subscribers` | json[] | **yes** | Users to unsubscribe | |
647 | 647 |
|
648 | 648 |
|
649 | | -## messaging (16 commands) |
| 649 | +## messaging (16) |
650 | 650 |
|
651 | 651 | ### messaging cancel-email |
652 | 652 |
|
@@ -858,7 +858,7 @@ iterable messaging send-whatsapp <campaignId> |
858 | 858 | | `--sendAt` | string | no | When to send (YYYY-MM-DD HH:MM:SS format) | |
859 | 859 |
|
860 | 860 |
|
861 | | -## snippets (5 commands) |
| 861 | +## snippets (5) |
862 | 862 |
|
863 | 863 | ### snippets create |
864 | 864 |
|
@@ -921,7 +921,7 @@ iterable snippets update --content <content> --identifier <identifier> |
921 | 921 | | `--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. | |
922 | 922 |
|
923 | 923 |
|
924 | | -## subscriptions (5 commands) |
| 924 | +## subscriptions (5) |
925 | 925 |
|
926 | 926 | ### subscriptions bulk-update |
927 | 927 |
|
@@ -996,7 +996,7 @@ iterable subscriptions unsubscribe-by-userid --subscriptionGroup <subscriptionGr |
996 | 996 | | `--userId` | string | **yes** | User's userId | |
997 | 997 |
|
998 | 998 |
|
999 | | -## templates (21 commands) |
| 999 | +## templates (21) |
1000 | 1000 |
|
1001 | 1001 | ### templates delete |
1002 | 1002 |
|
@@ -1350,7 +1350,7 @@ iterable templates upsert-sms <clientTemplateId> |
1350 | 1350 | | `--name` | string | no | Template name | |
1351 | 1351 |
|
1352 | 1352 |
|
1353 | | -## users (12 commands) |
| 1353 | +## users (12) |
1354 | 1354 |
|
1355 | 1355 | ### users bulk-update |
1356 | 1356 |
|
@@ -1499,7 +1499,7 @@ Update user subscriptions (overwrites existing data for any non-null fields spec |
1499 | 1499 | | `--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. | |
1500 | 1500 |
|
1501 | 1501 |
|
1502 | | -## webhooks (2 commands) |
| 1502 | +## webhooks (2) |
1503 | 1503 |
|
1504 | 1504 | ### webhooks list |
1505 | 1505 |
|
|
0 commit comments