Skip to content
RallyHere Docs

Get Marketing Campaigns

GET
/inventory/v1/marketing/campaign

Get all marketing campaigns. There is currently no way to add Market Campaigns via API. Reach out to your Rally Here representative to add a new campaign.

Authorizations

Responses

200

Successful Response

List of external Marketing Campaigns.

object
campaigns
required

List of external Marketing Campaigns

Array<object>

A Marketing Campaign is a set of external keys that can be claimed by players.The key claims are assigned to the player based on

object
uuid
required

The unique identifier for the Marketing Campaign

string format: uuid
name
required

The name of the Marketing Campaign

string
portal_id

Platform for the Marketing Campaign

integer
key_types
required

The types of keys that can be claimed from this campaign

Array<object>

A Key Type is a type of key that can be claimed from a Marketing Campaign.

object
type
required

The type of key

string
created_on

The time the MarketingCampaign was created

string
last_modified_on

The time the MarketingCampaign was last modified

string

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

409

Conflict

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

500

Internal Server Error

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string