Rule.io SDK

---

Rule.io SDK / client/src / SetSmsCampaignPayload

Type Alias: SetSmsCampaignPayload

SetSmsCampaignPayload = SetEmailCampaignPayload

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

Payload for CampaignsClient.setSmsCampaign (full replacement).

All five fields are required — the API replaces the entire campaign body. The message type is fixed to 'text_message' by the method.

Example

await client.campaigns.setSmsCampaign(campaignId, {
  name: 'Flash sale SMS',
  sendoutType: 'marketing',
  tags: [{ id: 42, negative: false }],
  segments: [],
  subscribers: [],
});