Customiser languages

Validate publishing a customiser language

Copy page

Dry-run a language publish without promoting anything. The response on the failing paths is exactly the problem the publish would return, including the missing_keys list, so an agent can report precisely what is still needed before committing.

POST/api/v3/customisers/{customiser_id}/languages/{language_code}/validate-publish

Validate publishing a customiser language

Dry-run a language publish without promoting anything. The response on the failing paths is exactly the problem the publish would return, including the `missing_keys` list, so an agent can report precisely what is still needed before committing. On a language that would publish, the response is a 200 `customiser_language_validation` confirmation. Nothing is written, no caches are touched, no idempotency key is consumed, and no activity is recorded. The verdict is advisory: nothing binds it to a later publish, and the draft copy can legitimately change between the two calls. Requires the `customisers:write` scope, because it is the write dry-run twin. 401, 403, 404, 409, 422, and 429 problems behave exactly as on the publish operation.

Validate publishing a customiser language

Overview

On a language that would publish, the response is a 200 customiser_language_validation confirmation. Nothing is written, no caches are touched, no idempotency key is consumed, and no activity is recorded. The verdict is advisory: nothing binds it to a later publish, and the draft copy can legitimately change between the two calls. Requires the customisers:write scope, because it is the write dry-run twin. 401, 403, 404, 409, 422, and 429 problems behave exactly as on the publish operation.

Authorisation

Bearer token required. Include it in theAuthorization header.

Required scope: customisers:write

Path parameters

customiser_idstringpathrequired

The customiser id, from the list customisers operation.

Example: 1

language_codestringpathrequired

The language tag, from the list customiser languages operation.

Example: fr

Validate publishing a customiser language

curl https://web.signcustomiser.com/api/v3/customisers/1/languages/fr/validate-publish \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'

{
  "data": {
    "object": "customiser_language_validation",
    "operation": "publish",
    "customiser_id": 42,
    "language_code": "fr",
    "valid": true
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/languages/fr/validate-publish",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "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, but the API key grants the following scopes: customisers:read. Create a key that includes the required scope in the merchant admin under Integrate → API Tokens.",
  "required_scopes": [
    "customisers:write"
  ],
  "granted_scopes": [
    "customisers:read"
  ],
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}

{
  "type": "https://www.signcustomiser.com/help/api/problems/language_publish_blocked",
  "title": "Language publish blocked",
  "status": 422,
  "code": "language_publish_blocked",
  "detail": "This language cannot be published while required copy is still blank. Write a draft value for every key in missing_keys, then retry. Stale values do not block publishing.",
  "missing_keys": [
    "selection:12:label"
  ],
  "missing_key_count": 1,
  "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
}