Sign Customiser

Navigation

Dark mode

Removes a share link, as Remove does on the merchant admin's Shares page: the link stops opening the design. The shopper's products, orders and quotes are not changed.

DELETE/api/v3/shares/{share_id}
DELETEDelete a share
DELETE/api/v3/shares/{share_id}

Delete a share

Removes a share link, as Remove does on the merchant admin's Shares page: the link stops opening the design. The shopper's products, orders and quotes are not changed. Requires `shares:write` and an `Idempotency-Key`. Retrying the same request and key replays the original success after the share is gone. The response is the share as it was.

Authorisation

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

Path

The share id, from the list shares operation.

Delete a share

Overview

Requires shares:write and an Idempotency-Key. Retrying the same request and key replays the original success after the share is gone. The response is the share as it was.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: shares:write

Path parameters

share_idstringpathrequired

The share id, from the list shares operation.

Example: 512

Delete a share
curl https://web.signcustomiser.com/api/v3/shares/512 \
  --request DELETE \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": {
    "object": "share",
    "id": 512,
    "customiser_id": 42,
    "customiser_name": "Neon signs",
    "image_url": "https://cdn.example.com/customisers/42/product.png",
    "created_at": "2026-07-18T03:14:15Z"
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/shares/512",
    "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.