Sign Customiser

Navigation

Dark mode

Customiser labels

Replace the additional information cards

Copy page

Replaces the Review Screen additional information cards, such as free shipping or a warranty, with the list you send, in order, at most 6. Each card has a header, a description and optionally an image: send upload_id, a label_image upload, or image_url, the URL the labels read publishes for an image a card already has.

PUT/api/v3/customisers/{customiser_id}/labels/additional-information
PUTReplace the additional information cards
PUT/api/v3/customisers/{customiser_id}/labels/additional-information

Replace the additional information cards

Replaces the Review Screen additional information cards, such as free shipping or a warranty, with the list you send, in order, at most 6. Each card has a `header`, a `description` and optionally an image: send `upload_id`, a `label_image` upload, or `image_url`, the URL the labels read publishes for an image a card already has. A card with neither has no image. Each upload is single use, and an image no card holds any longer is deleted once the write commits. Requires `customisers:write` and an `Idempotency-Key`. The write clears the storefront cache.

Authorisation

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

Path

The customiser id.

Body
Replace the additional information cards

Overview

A card with neither has no image. Each upload is single use, and an image no card holds any longer is deleted once the write commits. Requires customisers:write and an Idempotency-Key. The write clears the storefront cache.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: customisers:write

Path parameters

customiser_idstringpathrequired

The customiser id.

Example: 1

Request body

additional_informationarraybody

Request body example

application/json
{
  "additional_information": [
    {
      "header": "Free express shipping",
      "description": "Every sign ships free, worldwide.",
      "image_url": "https://cdn.signcustomiser.com/files/shipping.png"
    }
  ]
}
Replace the additional information cards
curl https://web.signcustomiser.com/api/v3/customisers/1/labels/additional-information \
  --request PUT \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "additional_information": [
    {
      "header": "Free express shipping",
      "description": "Every sign ships free, worldwide.",
      "image_url": "https://cdn.signcustomiser.com/files/shipping.png"
    }
  ]
}'
Response
{
  "data": {
    "object": "customiser_additional_information",
    "customiser_id": 42,
    "additional_information": [
      {
        "header": "Free express shipping",
        "description": "Every sign ships free, worldwide.",
        "image_url": "https://cdn.signcustomiser.com/files/shipping.png"
      }
    ]
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/labels/additional-information",
    "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.