Validate a campaign without creating it

Changed on

Runs the same validation, permission, eligibility, and billing-account resolution as CreateCampaign, without creating anything. HTTP 200 means validation ran; read valid and errors, which match the errors CreateCampaign would return for the same body. resolvedBillingAccountId is the account the campaign would be created in. Malformed JSON, account-resolution failures, and dependency failures return the usual error envelope. Takes no x-idempotency-key.

post/ads-management/v1/campaigns:validate

Request

  • Base URL
    https://apis.roblox.com
  • Auth
    • API key in cookie .ROBLOSECURITY
    • or API key in header x-api-key
    • or OAuth 2
      Authorization codehttps://apis.roblox.com/oauth/v1/authorize
      Token URLhttps://apis.roblox.com/oauth/v1/token
      Scopesad.campaign:write

Request body

autoReloadAdCreditEnabledboolean

Whether ad credit is reloaded automatically when it runs low. Defaults to false.

billingAccountIdstring

The billing account to create the campaign in: your own, or one owned by a group where you have advertising permission. Optional; defaults to your own account, also for a group-owned experience. To pay with the group's ad credit, pass the group's account from campaign-options billingAccounts. For a group's account, targetUniverseId must be an experience the group owns.

creativeAssetIdsstring[] required

The Open Cloud image asset IDs to advertise, as decimal strings. Required. The assets must already exist and be usable by the caller. These are Roblox asset IDs, the same values as Creative.assetId.

namestring required

The display name of the campaign. Required.

objective'PLAYS' | 'ENGAGEMENT' | 'ROBUX_SPEND' required

The advertising goal. Required. Can be PLAYS, ENGAGEMENT, or ROBUX_SPEND. ENGAGEMENT does not support targeting; ENGAGEMENT and ROBUX_SPEND are not available for every experience.

paymentType'CREDIT_CARD' | 'ADS_CREDIT' | 'INVOICE' required

How the campaign is paid for. Required. Can be CREDIT_CARD, ADS_CREDIT, or INVOICE, subject to what the billing account supports. A group's billing account accepts only ADS_CREDIT.

targetUniverseIdstring required

The identifier of the experience to advertise. Required.

Response

Validation ran

resolvedBillingAccountIdstring

The billing account the campaign would be created in.

validboolean required

Whether CreateCampaign would accept this request.

Changes