Skip to main content
Sandboxes

Update sandbox organisation

PUT/v4/config/platform/sandbox-org/{sandboxOrgId}

Changes the name, the description or the location of a sandbox organisation. Send only the fields to change: a field that you leave out keeps its value. An empty name or description also keeps its value; an empty location removes the location. The new name must be unique in the organisation. To change only the name, you can also use Update sandbox organisation name.

The wallet of the sandbox organisation takes the new values a moment after the answer. You cannot change the main wallet with this operation (400).

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:sandboxes:update

Path parameters

  • sandboxOrgIdstringrequired

    Unique identifier of the sandbox organisation.

Body

application/json

The fields of the sandbox organisation to change.

  • sandboxOrgobjectrequired

    The fields of the sandbox organisation to change.

Response

application/json

The sandbox organisation after the change.

  • sandboxOrgobject

    A sandbox organisation: a separate wallet inside the organisation, for tests.