v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB
Advertising

Creates a complete ad. Including ad campaign, ad set, escrow, and the ad. Currently intended for creation of sponsorships only.

post/v2/sponsored-campaigns/create

Request body

campaignTargetIdinteger

The ID of the campaign target

campaignTargetType0 | 1 | 2 | 3

The type of the campaign target ['Undefined' = 0, 'Universe' = 1, 'Asset' = 2, 'ImmersiveAd' = 3]

targetGender1 | 2 | 4

Targeting gender(s) of the ad set ['Undefined' = 1, 'Male' = 2, 'Female' = 4]

targetAgeBracket1 | 2 | 4 | 8 | 16

Targeting age bracket(s) of the ad set ['Undefined' = 1, 'AgeUnder13' = 2, 'Age13OrOver' = 4, 'Age13To16' = 8, 'Age17OrOver' = 16]

startDatestring date-time

The start date of the ad set

endDatestring date-time

The end date of the ad set

targetDeviceType1 | 2 | 4 | 8 | 16 | 32

Targeting device type(s) of the ad set ['Undefined' = 1, 'Computer' = 2, 'Phone' = 4, 'Tablet' = 8, 'Console' = 16, 'VR' = 32]

campaignNamestring

The name of the Campaign / Ad

dailyBidAmountInRobuxinteger

The daily bid amount for the campaign / ad, in Robux

placementLocation1 | 2 | 4 | 8 | 16 | 32 | 64 | 128

The location to place the campaign ['Undefined' = 1, 'GameSort' = 2, 'AvatarShop' = 4, 'ItemDetails' = 8, 'HomePage' = 16, 'Billboard300x250' = 32, 'Billboard600x300' = 64, 'Billboard300x600' = 128]

Example request

{
  "campaignTargetId": 1,
  "campaignTargetType": 2,
  "targetGender": 4,
  "targetAgeBracket": 4,
  "targetDeviceType": 2,
  "dailyBidAmountInRobux": 101,
  "placementLocation": 4,
  "creativeModel": {
    "creativeId": 1,
    "creativeType": 1
  }
}

Response

OK

integer required