Sign Customiser

Navigation

Dark mode

Dry-runs the switch: the body is the one the switch accepts, and a switch that would fail answers the identical 409 or 422 problem. A switch that would apply answers a 200 store_unit_switch_validation verdict.

POST/api/v3/stores/me/unit-switch/validate-create
POSTValidate a store unit switch
POST/api/v3/stores/me/unit-switch/validate-create

Validate a store unit switch

Dry-runs the switch: the body is the one the switch accepts, and a switch that would fail answers the identical 409 or 422 problem. A switch that would apply answers a 200 `store_unit_switch_validation` verdict. Nothing is written, the review token stays valid, and no idempotency key is consumed. Requires the `store:write` scope.

Authorisation

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Body
Validate a store unit switch

Overview

Nothing is written, the review token stays valid, and no idempotency key is consumed. Requires the store:write scope.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: store:write

Request body

measurement_unitstringbody

Request body example

application/json
{
  "measurement_unit": "cm"
}
Validate a store unit switch
curl https://web.signcustomiser.com/api/v3/stores/me/unit-switch/validate-create \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "measurement_unit": "cm"
}'
Response
{
  "data": {
    "object": "store_unit_switch_validation",
    "operation": "create",
    "valid": true
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/stores/me/unit-switch/validate-create",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.