Toggle one ad on or off

Changed on

Sets one ad's status to ACTIVE or PAUSED while leaving the campaign's creative set, targeting, and other ads unchanged. Returns 400 FAILED_PRECONDITION for REMOVED ads and for campaigns that have ended or been cancelled.

patch/ads-management/v1/campaigns/{campaignId}/ads/{adId}

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

Path parameters

campaignIdstring required

Campaign ID

adIdstring required

Ad ID

Request body

status'ACTIVE' | 'PAUSED' required

Target lifecycle status (ACTIVE or PAUSED).

Response

OK

creativeAssetIdstring required

The Roblox image asset ID this ad serves, as a decimal string. This is the same value as Creative.assetId.

deliveryStatus'SERVING' | 'IN_REVIEW' | 'NOT_SERVING' | 'REJECTED' required

Per-ad serving state (SERVING, IN_REVIEW, NOT_SERVING, or REJECTED).

idstring required

Stable ad ID; matches the ad ID in analytics-query-api.

removeTimestring date-time

Set when status is REMOVED, as an RFC 3339 UTC timestamp.

reviewStatus'IN_REVIEW' | 'APPROVED' | 'REJECTED' required

Combined result of the creative's review and the experience's review (IN_REVIEW, APPROVED, or REJECTED).

status'ACTIVE' | 'PAUSED' | 'REMOVED' required

Lifecycle intent for this ad (ACTIVE, PAUSED, or REMOVED).

Changes