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.

Responses

200

Successful Response

application/json

Schema

Schema

campaigns

object[]

required

List of external Marketing Campaigns

Array [

uuid uuidrequired

The unique identifier for the Marketing Campaign

name Name (string)required

The name of the Marketing Campaign

portal_id

object

Platform for the Marketing Campaign

anyOf

Portal

integer

Possible values: [-2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33]

key_types

object[]

required

The types of keys that can be claimed from this campaign

Array [

type Type (string)required

The type of key

]

created_on

object

The time the MarketingCampaign was created

anyOf

MOD1

string

last_modified_on

object

The time the MarketingCampaign was last modified

anyOf

MOD1

string

]

Example (from schema)

{
  "campaigns": [
    {
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "portal_id": -2,
      "key_types": [
        {
          "type": "string"
        }
      ],
      "created_on": "string",
      "last_modified_on": "string"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

409

Conflict

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

500

Internal Server Error

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

Loading...