PATCH /legacy-badges/v1/badges/{badgeId} — openapi

Updates badge configuration.

Managers may change enabled state, name, and description when authorized for the badge.

Endpoint

Method: PATCH

Path: /legacy-badges/v1/badges/{badgeId}

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
badgeId	path	true	The badge Id.

[
  {
    "in": "path",
    "name": "badgeId",
    "description": "The badge Id.",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  }
]

Request Body

The request body.

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Badges.Api.UpdateBadgeRequest"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/Roblox.Badges.Api.UpdateBadgeRequest"
      }
    }
  },
  "description": "The request body.",
  "required": true
}

Responses

Status	Description
200	OK
400	6: Text moderated. 14: Invalid badge name. 15: Invalid badge description.
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed 2: You do not have permission to manage this badge.
404	1: Badge is invalid or does not exist. 3: The game is invalid or does not exist.

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.ApiEmptyResponseModel"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Web.WebAPI.ApiEmptyResponseModel"
        }
      }
    }
  },
  "400": {
    "description": "6: Text moderated.\r\n14: Invalid badge name.\r\n15: Invalid badge description."
  },
  "401": {
    "description": "0: Authorization has been denied for this request."
  },
  "403": {
    "description": "0: Token Validation Failed\r\n2: You do not have permission to manage this badge."
  },
  "404": {
    "description": "1: Badge is invalid or does not exist.\r\n3: The game is invalid or does not exist."
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": []
    }
  ],
  "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": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Badges"
  ],
  "summary": "Updates badge configuration.",
  "description": "Managers may change enabled state, name, and description when authorized for the badge.",
  "parameters": [
    {
      "in": "path",
      "name": "badgeId",
      "description": "The badge Id.",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Badges.Api.UpdateBadgeRequest"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/Roblox.Badges.Api.UpdateBadgeRequest"
        }
      }
    },
    "description": "The request body.",
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.ApiEmptyResponseModel"
          }
        },
        "text/json": {
          "schema": {
            "$ref": "#/components/schemas/Roblox.Web.WebAPI.ApiEmptyResponseModel"
          }
        }
      }
    },
    "400": {
      "description": "6: Text moderated.\r\n14: Invalid badge name.\r\n15: Invalid badge description."
    },
    "401": {
      "description": "0: Authorization has been denied for this request."
    },
    "403": {
      "description": "0: Token Validation Failed\r\n2: You do not have permission to manage this badge."
    },
    "404": {
      "description": "1: Badge is invalid or does not exist.\r\n3: The game is invalid or does not exist."
    }
  },
  "x-roblox-stability": "EXPERIMENTAL",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 100
    },
    "perOauth2Authorization": {
      "period": "MINUTE",
      "maxInPeriod": 100
    }
  },
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": []
    }
  ],
  "x-roblox-scopes": [
    {
      "name": "legacy-universe.badge:write"
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/badges#patch_legacy_badges_v1_badges__badgeId_"
  }
}