Modify the rules of a sandbox property. Make changes to content-handling behaviors for testing purposes within your development environment. Once you're satisfied with the results in your sandbox, you can use the Property Manager API: Create a new property version, Update a property's rule tree, and Activate a property to apply the rule changes to your property configuration.

Recipes
Update sandbox rules
Open Recipe
Path Params
string
required

Unique identifier for the property within a sandbox.

string
required

Unique identifier for the sandbox.

Query Params
string
Defaults to USER

Enum The access level of the request. Either the default USER value to perform the request for the sandboxes that you can access, or ACCOUNT to perform the request for all sandboxes within the account.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
object
object
required

Specifies the rule tree for this sandbox property. The content-handling rules are defined in the Property Manager API.

Response

Response body
object
object
Has additional fields
array of strings

Behaviors in the rule tree that were modified for use in the Sandbox.

editedRuleBehaviors
array of strings

Behaviors in the rule tree that were removed because they aren't supported by Sandbox.

filteredRuleBehaviors
string

The Property Manager rule format used for validation.

array of objects

Warnings from validating the rule tree when a sandbox exists or a property is added. For details, refer to Errors.

validationWarnings
object
string

Read-only Provides specific information related to this validation warning.

string

Read-only Provides a path expression to the offending rule.

string

Read-only A unique identifier for this particular validation.

string

Read-only A unique name for this particular validation.

Language
Authentication
URL