Campaigns

post/api/v2/campaigns

Request

  • Base URL: https://api.richads.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.richads.com/api/v2/campaigns
  • Auth: HTTP bearer

Request body

type'push' | 'pops' | 'display' required

Campaign channel type

namestring nullable

Campaign name (auto-generated if omitted)

Example request

{
  "type": "push",
  "name": "My Push Campaign",
  "creatives": [
    {
      "size": 1
    }
  ],
  "targeting": {
    "country": "USA",
    "deviceTypes": [
      "Mobile",
      "Tablet",
      "Desktop"
    ]
  },
  "budget": {
    "budgetAmount": 100,
    "pacingType": "even",
    "budgetPeriod": "perDay",
    "cpaGoal": 2.5,
    "maxBid": 0.15
  },
  "schedule": {
    "timezone": "utc",
    "dateFrom": "2024-06-01",
    "dateTo": "2024-12-31",
    "timeFrom": "08:00",
    "timeTo": "22:00"
  },
  "sources": {
    "list": [
      1,
      5,
      12
    ],
    "whiteList": [
      "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
      "f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3"
    ],
    "blockList": [
      "b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5",
      "d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1"
    ]
  }
}

Response

Campaign created. Response includes the full campaign data with sources.blockList (blocked site IDs), sources.whiteList (whitelisted site IDs), and sources.list (SSP IDs).

idinteger

Campaign ID

statusstring

Campaign status

type'push' | 'pops' | 'display'

Campaign channel type

telegramTypestring nullable

Telegram campaign subtype (null for non-Telegram campaigns)

namestring

Campaign name

Example response

{
  "id": 12345,
  "status": "active",
  "type": "push",
  "name": "My Push Campaign",
  "targeting": {
    "country": "USA",
    "deviceTypes": [
      "Mobile",
      "Tablet",
      "Desktop"
    ]
  },
  "budget": {
    "budgetAmount": 100,
    "pacingType": "even",
    "budgetPeriod": "perDay",
    "cpaGoal": 2.5,
    "maxBid": 0.15
  },
  "sources": {
    "list": [
      1,
      5,
      12
    ],
    "whiteList": [
      "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
      "f6e5d4c3b2a1f6e5d4c3b2a1f6e5d4c3"
    ],
    "blockList": [
      "b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5",
      "d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.