Documentation and GuidesAPI Reference
API Reference

Create a campaign

post
https://apps.hivestack.com/api/v2/campaigns

Creates one or multiple campaign associated with your organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A payload containing required campaign fields.

account
object
integer
required

The ID of the account associated with the campaign.

advertiser
object
integer
required

The ID of the advertiser associated with the campaign.

number

Budget cap of the campaign.

number
Defaults to null

Daily Spend Cap associated to the campaign.

integer
Defaults to 0

Equivalent to frequency cap. Prevents plays from the same campaign for a number of seconds after a play.

string
required

The name of the campaign.

string
Defaults to null

Additional notes that might be associated with the campaign.

string
integer
enum
Defaults to 5

Optional integer with a value between 1 and 9 (inclusive) used to prioritize the line items of the campaign, 1 being the lowest priority and 9 being the highest priority (opposite of the Ui behaviour where 1 is the highest). If this field is not null, the priority of the line items in the campaign will be overwritten by this value.

campaign_properties
array of objects
campaign_properties
string
string
Responses

Updated 6 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago