POST /v2/sponsored-campaigns/stop — openapi

Stops a sponsored campaign / ad (ad set) from running. Initiated by a user.

Endpoint

Method: POST

Path: /v2/sponsored-campaigns/stop

Servers:

https://adconfiguration.roblox.com

Request Body

Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest"
      }
    }
  },
  "description": "Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest",
  "required": true
}

Responses

Status	Description
200	OK
400	10: Insufficient permissions. 14: Invalid ad set id. 31: Internal server error
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed
503	1: This feature is disabled.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "format": "int64",
          "type": "integer"
        }
      },
      "text/json": {
        "schema": {
          "format": "int64",
          "type": "integer"
        }
      }
    }
  },
  "400": {
    "description": "10: Insufficient permissions.\r\n14: Invalid ad set id.\r\n31: Internal server error"
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "403": {
    "description": "0: Token Validation Failed"
  },
  "503": {
    "description": "1: This feature is disabled."
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest

Complete Operation Definition

{
  "tags": [
    "Advertising"
  ],
  "summary": "Stops a sponsored campaign / ad (ad set) from running. Initiated by a user.",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest"
        }
      }
    },
    "description": "Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "format": "int64",
            "type": "integer"
          }
        },
        "text/json": {
          "schema": {
            "format": "int64",
            "type": "integer"
          }
        }
      }
    },
    "400": {
      "description": "10: Insufficient permissions.\r\n14: Invalid ad set id.\r\n31: Internal server error"
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "403": {
      "description": "0: Token Validation Failed"
    },
    "503": {
      "description": "1: This feature is disabled."
    }
  },
  "servers": [
    {
      "url": "https://adconfiguration.roblox.com"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/advertising#adconfiguration_post_v2_sponsored_campaigns_stop"
  }
}