Sign Customiser

Navigation

Dark mode

Makes a published, complete language the customiser's authoring language, the one whose rows own the option, selection, setting, letter-part and form text, as the merchant admin's "Make primary language" does. The other languages' copy of that text is then translated from it.

POST/api/v3/customisers/{customiser_id}/languages/{language_code}/authoring
POSTSet the authoring language
POST/api/v3/customisers/{customiser_id}/languages/{language_code}/authoring

Set the authoring language

Makes a published, complete language the customiser's authoring language, the one whose rows own the option, selection, setting, letter-part and form text, as the merchant admin's "Make primary language" does. The other languages' copy of that text is then translated from it. The change can replace draft values the language holds for that text with its published values, and clear optional text it has no value for. So call the validate twin first: it reports `replaced_draft_count` and `cleared_optional_count` and returns a `plan_token`. Confirm the counts with the merchant, then send the token here. If the language's copy changed since the check, so the counts would now differ, the write is refused with 409 `stale_revision` and changes nothing: validate again. Making the current authoring language authoring again changes nothing. Refusals: 422 `language_not_authorable` with `reason` `not_published`, `incomplete_published_translations` or `no_authoring_language`; 409 `ai_translation_in_progress` while any AI translation runs on the customiser; 409 `stale_revision` for a stale `plan_token`. Requires `customisers:write` and an `Idempotency-Key`. The write clears the storefront cache and runs the language sync; it never regenerates Shopify products.

Authorisation

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

Path

The customiser id.

The language tag.

Body
Set the authoring language

Overview

The change can replace draft values the language holds for that text with its published values, and clear optional text it has no value for. So call the validate twin first: it reports replaced_draft_count and cleared_optional_count and returns a plan_token. Confirm the counts with the merchant, then send the token here. If the language's copy changed since the check, so the counts would now differ, the write is refused with 409 stale_revision and changes nothing: validate again. Making the current authoring language authoring again changes nothing. Refusals: 422 language_not_authorable with reason not_published, incomplete_published_translations or no_authoring_language; 409 ai_translation_in_progress while any AI translation runs on the customiser; 409 stale_revision for a stale plan_token. Requires customisers:write and an Idempotency-Key. The write clears the storefront cache and runs the language sync; it never regenerates Shopify products.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: customisers:write

Path parameters

customiser_idstringpathrequired

The customiser id.

Example: 1

language_codestringpathrequired

The language tag.

Example: fr

Request body

plan_tokenstringbody

Request body example

application/json
{
  "plan_token": "9c1e4f0b2a7d4e8f9a6b3c5d7e1f2a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f"
}
Set the authoring language
curl https://web.signcustomiser.com/api/v3/customisers/1/languages/fr/authoring \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "plan_token": "9c1e4f0b2a7d4e8f9a6b3c5d7e1f2a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f"
}'
Response
{
  "data": {
    "object": "customiser_language",
    "customiser_id": 42,
    "language_code": "fr",
    "source_language_code": "en",
    "display_name": "French",
    "status": "published",
    "is_default": false,
    "is_authoring": true,
    "translation_summary": {
      "key_count": 184,
      "required_key_count": 96,
      "translated_key_count": 184,
      "retired_key_count": 0,
      "missing_required_key_count": 0,
      "publishable": true
    },
    "ai_translation": null,
    "published_at": "2026-05-04T09:12:31Z",
    "created_at": "2026-05-04T09:09:00Z",
    "updated_at": "2026-05-04T09:14:02Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/languages/fr/authoring",
    "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.