Skip to main content
POST
/
vendor
/
campaigns
Create campaign
curl --request POST \
  --url https://api.example.com/vendor/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "campaign_identifier": "<string>",
  "description": "<string>",
  "starts_at": "<string>",
  "ends_at": "<string>",
  "budget": {
    "type": "spend",
    "limit": 123,
    "currency_code": "<string>"
  }
}
'
{
  "campaign": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "currency": "<string>",
    "campaign_identifier": "<string>",
    "starts_at": "<string>",
    "ends_at": "<string>",
    "budget": {
      "id": "<string>",
      "type": "spend",
      "currency_code": "<string>",
      "limit": 123,
      "used": 123
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

Comma-separated fields to include in the response.

Body

application/json
​
name
string

The campaign's name.

​
campaign_identifier
string

The campaign's identifier.

​
description
string

The campaign's description.

​
starts_at
string

The date and time that the campaign starts.

​
ends_at
string

The date and time that the campaign ends.

​
budget
object

Response

201 - application/json

Created

​
campaign
object

The campaign's details.