Assets
Avatars

Publishes a given target as a Collectible.

Changed on
post/v1/collectibles

Request

  • Base URL
    https://itemconfiguration.roblox.com
  • Auth
    • API key in cookie .ROBLOSECURITY
    • or API key in header x-api-key

Request body

isRentalOptInboolean

Whether the item is opted into rental.

idempotencyTokenstring

Idempotency token for publishing purposes.

targetIdinteger

Target item's Id.

targetType0 | 1 | 2 | 3

Target item's type. ['Asset' = 0, 'Bundle' = 1, 'IecToken' = 2, 'Look' = 3]

publishingType0 | 1 | 2

Publishing type of the CollectibleItem. ['Invalid' = 0, 'Limited' = 1, 'NonLimited' = 2]

agreedPublishingFeeinteger

The publishing fee seen by the end-user.

creatorUserIdinteger

The UserId of the creator if the creator is a user.

creatorGroupIdinteger

The GroupId of the creator if the creator is a group.

publisherUserIdinteger

The UserId of the publisher who pays the publishing fee. This should only be set if the creator is a group.

quantityinteger

The total number of instances for the CollectibleItem.

quantityLimitPerUserinteger

The max number of instances for the CollectibleItem a user can own.

resaleRestriction0 | 1 | 2

The resale restriction of the CollectibleItem. ['INVALID' = 0, 'NONE' = 1, 'DISABLED' = 2]

priceInRobuxinteger

The sale price of the CollectibleItem and it will be used as minimum price for DPF.

priceOffsetinteger

Gets or sets the price offset of the item in Robux above the price floor.

optOutFromRegionalPricingboolean

Whether to opt out of the regional pricing.

isFreeboolean

Gets or sets if the item is free.

namestring

The desired name of the CollectibleItem. If not set, will use the underlying itemname.

descriptionstring

The desired description of the CollectibleItem. If not set, will use the underlying itemname.

onSaleTimestring date-time

Scheduled on sale time for publishing the item.

offSaleTimestring date-time

Scheduled off sale time for publishing the item.

agreementIdstring

Optional. Content-licensing agreement id for a licensed publish. If unset, publishing behavior is unchanged. Not persisted on the collectible.

Response

OK

status0 | 1 | 2

The status of the collectible being published. ['Succeeded' = 0, 'Failed' = 1, 'InProgress' = 2]

Changes