Rule.io SDK

---

Rule.io SDK / client/src / CreateDefaultCampaignResult

Interface: CreateDefaultCampaignResult

Defined in: client/src/resources/campaigns/campaigns.types.ts:409

Result from CampaignsClient.createDefaultEmailCampaign or CampaignsClient.createDefaultSmsCampaign.

Contains the IDs of all resources created during the campaign setup sequence: campaign → message → template → dynamic set.

Example

const result = await client.campaigns.createDefaultEmailCampaign({
  brandStyleId: 42,
});
console.log(result.campaignId, result.messageId, result.templateId, result.dynamicSetId);

Properties

campaignId

campaignId: number

Defined in: client/src/resources/campaigns/campaigns.types.ts:411

The created campaign ID.

---

dynamicSetId

dynamicSetId: number

Defined in: client/src/resources/campaigns/campaigns.types.ts:417

The created dynamic set ID linking the message to the template.

---

messageId

messageId: number

Defined in: client/src/resources/campaigns/campaigns.types.ts:413

The created message ID.

---

templateId

templateId: number

Defined in: client/src/resources/campaigns/campaigns.types.ts:415

The created template ID.