Skip to main content

Create Campaign

Create a new campaign in draft status.


Endpoint

POST https://api.campaignlark.com/v1/campaigns

Request Body

FieldTypeRequiredDescription
namestringrequiredCampaign name. Must be 1–255 characters.
typestringrequiredSINGLE_VARIANT or AB_TESTING.

Sample Request

POST https://api.campaignlark.com/v1/campaigns
Content-Type: application/json

{
"name": "Summer Sale Campaign",
"type": "SINGLE_VARIANT"
}

Response

Success — 201 Created

{
"error": null,
"data": {
"id": "64f1a2b3c4d5e6f7a8b9c0d1",
"name": "Summer Sale Campaign",
"type": "SINGLE_VARIANT"
}
}

Errors

StatusMessageCause
400Please provide a valid request body.Request body could not be parsed.
400Please provide a name for this campaign.name is empty or whitespace.
400The campaign name must be 255 characters or less.name exceeds 255 characters.
400Invalid campaign type. Must be 'SINGLE_VARIANT' or 'AB_TESTING'.type is not a valid campaign type.