Starsender icon

Starsender

Interact with Starsender API

Campaign → Create a Campaign

AI-generated

Summary

Create a new campaign in the Starsender API.

Inputs

  • authHeaderName (required) — Header name to send the API key in. Select 'Other' to provide a custom header name.
  • authHeaderCustom — Custom header name to use when Auth Header Name is set to Other.
  • campaignDeviceKey (required) — The device API key associated with the campaign.
  • campaignName (required) — The name of the campaign.
  • campaignSyntax (required) — Syntax format for the campaign, such as 'Registrasi#Nama#Alamat'.
  • campaignWelcome — Welcome message for the campaign.
  • campaignNumber — Optional campaign number.

Output shape

a response with campaign details if successful, otherwise an error message.

Ensure required parameters like campaignDeviceKey, campaignName, and campaignSyntax are provided to avoid runtime errors.

Examples

Example 1: Create a campaign with a welcome message and specific syntax parameters.

Inputs should include authHeaderName, campaignDeviceKey, campaignName, campaignSyntax, and optionally campaignWelcome.

Discussion