Skip to content

Commit 74d30b0

Browse files
danrowdendanrowden
committed
Revert ID name change
1 parent d4c43ad commit 74d30b0

2 files changed

Lines changed: 76 additions & 71 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -929,7 +929,7 @@ Retrieve a single transactional email by ID.
929929

930930
| Name | Type | Required | Notes |
931931
| --------------------- | ------ | -------- | ------------------------------------ |
932-
| `id` | string | Yes | The ID of the transactional email. |
932+
| `transactionalId` | string | Yes | The ID of the transactional email. |
933933

934934
#### Example
935935

@@ -970,7 +970,7 @@ Update a transactional email by ID. At least one field is required.
970970

971971
| Name | Type | Required | Notes |
972972
| --------------------- | ------ | -------- | -------------------------------------------------------- |
973-
| `id` | string | Yes | The ID of the transactional email. |
973+
| `transactionalId` | string | Yes | The ID of the transactional email. |
974974
| `name` | string | No | The name of the transactional email. |
975975
| `transactionalGroupId`| string | No | The ID of the group to move this transactional email to. |
976976

@@ -998,7 +998,7 @@ Ensure a transactional email has a draft email message. Use [`updateEmailMessage
998998

999999
| Name | Type | Required | Notes |
10001000
| ---- | ------ | -------- | ---------------------------------- |
1001-
| `id` | string | Yes | The ID of the transactional email. |
1001+
| `transactionalId` | string | Yes | The ID of the transactional email. |
10021002

10031003
#### Example
10041004

@@ -1018,7 +1018,7 @@ Publish a transactional email's current draft.
10181018

10191019
| Name | Type | Required | Notes |
10201020
| ---- | ------ | -------- | ---------------------------------- |
1021-
| `id` | string | Yes | The ID of the transactional email. |
1021+
| `transactionalId` | string | Yes | The ID of the transactional email. |
10221022

10231023
#### Example
10241024

@@ -1117,7 +1117,7 @@ Retrieve a single theme by ID.
11171117

11181118
| Name | Type | Required | Notes |
11191119
| ---- | ------ | -------- | -------------------- |
1120-
| `id` | string | Yes | The ID of the theme. |
1120+
| `themeId` | string | Yes | The ID of the theme. |
11211121

11221122
#### Example
11231123

@@ -1199,7 +1199,7 @@ Retrieve a single component by ID.
11991199

12001200
| Name | Type | Required | Notes |
12011201
| ---- | ------ | -------- | ------------------------- |
1202-
| `id` | string | Yes | The ID of the component. |
1202+
| `componentId` | string | Yes | The ID of the component. |
12031203

12041204
#### Example
12051205

@@ -1341,7 +1341,7 @@ Retrieve a single campaign by ID.
13411341

13421342
| Name | Type | Required | Notes |
13431343
| ---- | ------ | -------- | ----------------------- |
1344-
| `id` | string | Yes | The ID of the campaign. |
1344+
| `campaignId` | string | Yes | The ID of the campaign. |
13451345

13461346
#### Example
13471347

@@ -1383,7 +1383,7 @@ Update a draft campaign's name, group, audience, or scheduling. At least one fie
13831383

13841384
| Name | Type | Required | Notes |
13851385
| ------------------- | ------ | -------- | ---------------------------------------------------------------------------------------- |
1386-
| `id` | string | Yes | The ID of the campaign. |
1386+
| `campaignId` | string | Yes | The ID of the campaign. |
13871387
| `name` | string | No | The campaign name. |
13881388
| `campaignGroupId` | string | No | The ID of the group to move this campaign to. |
13891389
| `mailingListId` | string | No | The ID of the mailing list to send to. |
@@ -1439,7 +1439,7 @@ Retrieve an email message, including its compiled LMX content.
14391439

14401440
| Name | Type | Required | Notes |
14411441
| ---- | ------ | -------- | ---------------------------- |
1442-
| `id` | string | Yes | The ID of the email message. |
1442+
| `emailMessageId` | string | Yes | The ID of the email message. |
14431443

14441444
#### Example
14451445

@@ -1478,7 +1478,7 @@ Update fields on an email message (subject, preview text, sender, LMX content).
14781478

14791479
| Name | Type | Required | Notes |
14801480
| ------------------------------ | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
1481-
| `id` | string | Yes | The ID of the email message. |
1481+
| `emailMessageId` | string | Yes | The ID of the email message. |
14821482
| `expectedRevisionId` | string | No | The `contentRevisionId` you last fetched. Used for optimistic concurrency. |
14831483
| `subject` | string | No | The email subject. |
14841484
| `previewText` | string | No | The email preview text. |
@@ -1596,7 +1596,7 @@ Retrieve a single transactional group by ID.
15961596

15971597
| Name | Type | Required | Notes |
15981598
| ---- | ------ | -------- | ---------------------------------- |
1599-
| `id` | string | Yes | The ID of the transactional group. |
1599+
| `transactionalGroupId` | string | Yes | The ID of the transactional group. |
16001600

16011601
#### Example
16021602

@@ -1615,7 +1615,7 @@ Update a transactional group's name or description. At least one field must be p
16151615

16161616
| Name | Type | Required | Notes |
16171617
| ------------- | ------ | -------- | ---------------------------------- |
1618-
| `id` | string | Yes | The ID of the transactional group. |
1618+
| `transactionalGroupId` | string | Yes | The ID of the transactional group. |
16191619
| `name` | string | No | The group name. |
16201620
| `description` | string | No | A description for the group. |
16211621

@@ -1658,7 +1658,7 @@ Retrieve a single audience segment by ID.
16581658

16591659
| Name | Type | Required | Notes |
16601660
| ---- | ------ | -------- | -------------------------------- |
1661-
| `id` | string | Yes | The ID of the audience segment. |
1661+
| `audienceSegmentId` | string | Yes | The ID of the audience segment. |
16621662

16631663
#### Example
16641664

@@ -1719,7 +1719,7 @@ Retrieve a single campaign group by ID.
17191719

17201720
| Name | Type | Required | Notes |
17211721
| ---- | ------ | -------- | ----------------------------- |
1722-
| `id` | string | Yes | The ID of the campaign group. |
1722+
| `campaignGroupId` | string | Yes | The ID of the campaign group. |
17231723

17241724
#### Example
17251725

@@ -1738,7 +1738,7 @@ Update a campaign group's name or description. At least one field must be provid
17381738

17391739
| Name | Type | Required | Notes |
17401740
| ------------- | ------ | -------- | ----------------------------- |
1741-
| `id` | string | Yes | The ID of the campaign group. |
1741+
| `campaignGroupId` | string | Yes | The ID of the campaign group. |
17421742
| `name` | string | No | The group name. |
17431743
| `description` | string | No | A description for the group. |
17441744

@@ -1761,7 +1761,7 @@ Send a test preview of an email message to one or more addresses.
17611761

17621762
| Name | Type | Required | Notes |
17631763
| ------------------- | -------- | -------- | ------------------------------------------------------------------------------------------- |
1764-
| `id` | string | Yes | The ID of the email message. |
1764+
| `emailMessageId` | string | Yes | The ID of the email message. |
17651765
| `emails` | string[] | Yes | One or more addresses to send the preview to. |
17661766
| `contactProperties` | object | No | Contact property values to render. Accepted for campaign and workflow previews. |
17671767
| `eventProperties` | object | No | Event property values to render. Accepted for workflow previews only. |
@@ -1809,7 +1809,7 @@ Retrieve a workflow graph with node type names, connections, and selected displa
18091809

18101810
| Name | Type | Required | Notes |
18111811
| ---- | ------ | -------- | ------------------------ |
1812-
| `id` | string | Yes | The ID of the workflow. |
1812+
| `workflowId` | string | Yes | The ID of the workflow. |
18131813

18141814
#### Example
18151815

@@ -1829,7 +1829,7 @@ Retrieve detailed data for a single workflow node.
18291829
| Name | Type | Required | Notes |
18301830
| ------------ | ------ | -------- | ---------------------------- |
18311831
| `workflowId` | string | Yes | The ID of the workflow. |
1832-
| `id` | string | Yes | The ID of the workflow node. |
1832+
| `nodeId` | string | Yes | The ID of the workflow node. |
18331833

18341834
#### Example
18351835

@@ -1885,7 +1885,7 @@ const resp = await loops.completeUpload("clu7f1w3y011yl70m5n6o7p8q");
18851885

18861886
## Version history
18871887

1888-
- `v7.0.0` (Jun 23, 2026)
1888+
- `v7.0.0` (Jun 24, 2026)
18891889
- Added transactional email management ([`getTransactionalEmail()`](#gettransactionalemail), [`createTransactionalEmail()`](#createtransactionalemail), [`updateTransactionalEmail()`](#updatetransactionalemail), [`ensureTransactionalEmailDraft()`](#ensuretransactionalemaildraft), [`publishTransactionalEmail()`](#publishtransactionalemail)).
18901890
- Added workflows ([`listWorkflows()`](#listworkflows), [`getWorkflow()`](#getworkflow), [`getWorkflowNode()`](#getworkflownode)).
18911891
- Added image uploads ([`createUpload()`](#createupload), [`completeUpload()`](#completeupload)).
@@ -1898,7 +1898,6 @@ const resp = await loops.completeUpload("clu7f1w3y011yl70m5n6o7p8q");
18981898
- Expanded [`updateEmailMessage()`](#updateemailmessage) with `ccEmail`, `bccEmail`, `languageCode`, `emailFormat`, and property fallback maps.
18991899
- Renamed list methods to use a consistent `list` naming pattern (breaking change): [`listContactProperties()`](#listcontactproperties), [`listMailingLists()`](#listmailinglists), [`listTransactionalEmails()`](#listtransactionalemails), [`listDedicatedSendingIps()`](#listdedicatedsendingips), [`listThemes()`](#listthemes), [`listComponents()`](#listcomponents), and [`listCampaigns()`](#listcampaigns). Note `getCustomProperties` is now `listContactProperties`.
19001900
- [`listTransactionalEmails()`](#listtransactionalemails) uses a new underlying API endpoint and returns an updated response shape (including `transactionalGroupId`).
1901-
- Breaking change: resource ID parameters on get/update methods are now named `id` instead of resource-specific names like `transactionalId` or `campaignId`.
19021901
- Breaking change: API response objects now use `id` instead of `campaignId`, `themeId`, `componentId`, and `emailMessageId`. List and detail responses no longer include a top-level `success` field.
19031902
- `v6.4.0` (May 18, 2026) - Added `getDedicatedSendingIps()`, and endpoints for creating and editing campaings (`getThemes()`, [`getTheme()`](#gettheme), `getComponents()`, [`getComponent()`](#getcomponent), `getCampaigns()`, [`createCampaign()`](#createcampaign), [`getCampaign()`](#getcampaign), [`updateCampaign()`](#updatecampaign), [`getEmailMessage()`](#getemailmessage), and [`updateEmailMessage()`](#updateemailmessage)).
19041903
- `v6.3.0` (Apr 8, 2026) - Added [`checkContactSuppression()`](#checkcontactsuppression) and [`removeContactSuppression()`](#removecontactsuppression) methods.

0 commit comments

Comments
 (0)