POST/api/v1/campaigns

Create a campaign

Creates a campaign in your project. Provide subject and settings in the data object; settings must include its type field.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field

Campaign details in a data object.

dataobjectoptional
Custom campaign data as an object.

1 status code
200Returns the created campaign object, including its campaign data and identifier.
dataobjectoptional

Error handling

subject and settings are required within data, and settings.type is required within settings. The request body itself is optional, but omitting these required fields from data does not satisfy the campaign schema.