ROroblox
Badges
Universes

Creates a new badge.

Changed on

Charges the selected payment source and creates the badge under the universe's root place.

post/legacy-badges/v1/universes/{universeId}/badges

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/legacy-badges/v1/universes/{universeId}/badges
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: legacy-universe.badge:manage-and-spend-robux

Path parameters

universeIdinteger required

The ID of the universe to create the badge for.

Request body multipart/form-data

namestring

The badge name.

descriptionstring

The badge description.

paymentSourceType1 | 2

Whether or not to pay for the badge with user funds, or group funds.

filesstring binary

The badge icon. Optional: when omitted and a curated default badge icon is configured on the service, the badge is created with that default icon. When provided, exactly one file must be supplied.

expectedCostinteger

User expected cost of a badge.

isActiveboolean

Whether or not the badge should be created in the active state.

Response

OK

idinteger
namestring
descriptionstring
displayNamestring
displayDescriptionstring
enabledboolean
iconImageIdinteger
displayIconImageIdinteger
createdstring date-time
updatedstring date-time

Changes

  • a088ae4955d2Revision changes
    • info

      the security scope legacy-universe.badge:manage-and-spend-robux was added to the endpoint's security scheme roblox-oauth2