Customisers

Validate a customiser create

Copy page

POST/api/v3/customisers/validate-create

Validate a customiser create

Dry-runs the create without creating anything: the same body, the same prototype checks, and the same problems the create would return, or a 200 verdict when it would succeed. The verdict carries `will_be_active`, the activation-quota answer the create would apply, so an agent can tell a merchant in advance whether the new customiser goes live. Nothing is written, no idempotency key is consumed, and no option-write budget is spent, so the operation is always safe to repeat. The verdict is advisory — nothing binds it to a later create, and the store's live slots can change between the two calls. Requires `customisers:write`.

Overview

Nothing is written, no idempotency key is consumed, and no option-write budget is spent, so the operation is always safe to repeat. The verdict is advisory — nothing binds it to a later create, and the store's live slots can change between the two calls. Requires customisers:write.

Authorisation

Bearer token required. Include it in theAuthorization header.

Required scope: customisers:write

Request body

prototypestringbody

namestringbody

Request body example

{
  "prototype": "neon-frame-fit",
  "name": "Neon sign builder"
}

Validate a customiser create

curl https://web.signcustomiser.com/api/v3/customisers/validate-create \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "prototype": "neon-frame-fit",
  "name": "Neon sign builder"
}'

{
  "data": {
    "object": "customiser_validation",
    "operation": "create",
    "customiser_id": null,
    "prototype": "neon-frame-fit",
    "will_be_active": true,
    "valid": true
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/validate-create",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/missing_api_key",
  "title": "Missing API key",
  "status": 401,
  "code": "missing_api_key",
  "detail": "Provide a store API key as a bearer token.",
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "This operation requires the customisers:write scope.",
  "required_scopes": [
    "customisers:write"
  ],
  "granted_scopes": [
    "customisers:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "code": "validation_failed",
  "detail": "There is no prototype with id \"neon\".",
  "errors": [
    {
      "pointer": "/prototype",
      "code": "prototype_not_found",
      "detail": "The prototype \"neon\" does not exist."
    }
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/rate_limited",
  "title": "Too many requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "You have exceeded the request limit for this API key.",
  "retry_after": 60,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}