Appearance
Rule.io SDK / client/src / CreateSmsCampaignPayload
Type Alias: CreateSmsCampaignPayload
CreateSmsCampaignPayload =
CreateEmailCampaignPayload
Defined in: client/src/resources/campaigns/campaigns.types.ts:209
Payload for CampaignsClient.createSmsCampaign.
The message type is fixed to 'text_message' by the method — do not include it here. A campaign starts with no name and no recipients; add those with CampaignsClient.updateSmsCampaign before scheduling.
Example
typescript
const campaign = await client.campaigns.createSmsCampaign({
name: 'Flash sale SMS',
});