Reference / Settings

Enable/disable test/sandbox mode. Refused on production apps (422). Emits `settings.updated`.

PUT /v1/applications/{id}/sandbox

Secret API key operationId: set_sandbox

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Path parameters

id string<uuid> required

Application id

Request body · required

sandbox boolean required

Responses

200 Updated

{
  "data": {
    "sandbox": false
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}

422 Sandbox not allowed on production

Request

curl -X PUT "http://localhost:8080/v1/applications/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f/sandbox" \
  -H "Content-Type: application/json" \
  -d '{
  "sandbox": false
}'

Try it

live request

PUT http://localhost:8080/v1/applications/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f/sandbox

Path parameters

id *

Request body

application/json