Roblox Cloud icon

Roblox Cloud

Access Roblox Open Cloud APIs for groups, users, universes, places, storage, and more

Actions94

Universe → Update Place User Restriction

AI-generated

Overview

This node operation updates a user restriction for a specific place within a Roblox universe. It allows modifying details such as the restriction's active status, display and private reasons, duration, exclusion of alternate accounts, and start time. This is useful for managing user access and behavior restrictions in Roblox game places, ensuring controlled gameplay environments.

Use Case Examples

  1. Updating a user's game join restriction to temporarily ban them from a specific place in a Roblox universe.
  2. Changing the display reason for a user restriction to inform the user why they are restricted.

Properties

Name Meaning
Universe ID The unique identifier of the Roblox universe where the place exists.
Place ID The unique identifier of the place within the universe where the user restriction applies.
User Restriction ID The unique identifier of the user restriction to update.
Idempotency Key A unique key to ensure the update request is idempotent, preventing duplicate updates.
Idempotency Key First Sent The ISO timestamp indicating when the first idempotent request was sent.
Update Mask Specifies which fields of the user restriction to update, typically 'game_join_restriction'.
Update Fields Collection of fields to update within the game join restriction, such as active status, display reason, duration, exclusion of alternate accounts, private reason, and start time.

Output

JSON

  • userRestriction - The updated user restriction object returned from the API after the update operation.

Dependencies

  • Requires an API key credential for Roblox Cloud API authentication.

Troubleshooting

  • Ensure that the Universe ID, Place ID, and User Restriction ID are correct and exist in Roblox to avoid 'not found' errors.
  • Verify that the Idempotency Key is unique for each distinct update request to prevent unintended duplicate updates.
  • Check that the Update Mask field is correctly set to 'game_join_restriction' as nested fields are not supported, otherwise the update may fail.
  • Make sure the duration is within the valid range (1 second to 315576000000 seconds) and formatted correctly (e.g., '3600s').
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation or configure a proper proxy if needed.

Discussion