Sign Customiser

Navigation

Dark mode

Shares

delete_share

destructive write

Delete share

Copy page

Stop a share link from opening the design it was made for.

Overview

Removes a share link a shopper made for a design, as Remove does on the merchant admin Shares page. The link stops opening the design for anyone who has it, and it cannot be restored. It changes no product, order or quote. The call needs confirm: true. An exact retry with the same idempotency_key replays the deletion while the share remains deleted. The result is the share as it was. It requires the shares:write scope and an idempotency_key.

Permission

Requires theshares:writepermission. A connection without it answersinsufficient_scopenaming the permission to approve.

Annotations

readOnlyHintfalse
destructiveHinttrue
idempotentHinttrue
openWorldHintfalse

Prerequisites

  • A share id from list_shares.
  • A merchant has connected this store and approved the shares:write scope.

Side effects

  • Deletes the share link permanently. Anyone who has the link can no longer open the design.
  • Changes no product, order or quote.
  • Claims the idempotency_key for at least 24 hours.

Arguments

share_idintegerrequired

The share id, from list_shares.

confirmbooleanrequired

Must be true to apply the change, because the share link stops opening the design permanently and cannot be restored. Without it the call returns a confirmation_required error and changes nothing.

idempotency_keystringrequired

A client-generated key unique to this logical write, such as a UUID. Required: repeating the call with the same key and the same arguments replays the original result instead of writing twice, and the same key with different arguments is an idempotency_key_conflict.

Result

The share as it was, so a caller can report what it removed.

request_idstringalways present
storeobjectalways present
store.idintegeralways present
store.namestringalways present
share_idintegeralways present
deletedboolean

Present and true when the share was removed.

shareobject

The share as it was, so a caller can report what it removed.

share.idintegeralways present
share.customiser_idintegeralways present
share.customiser_namestringalways present
share.image_urlstring or null

The product image of the customiser, as the merchant admin shows it. Null when the customiser has none.

share.created_atstring or null

When the shopper made the link, UTC. Null on links older than the record.

idempotent_replayboolean

True when this call replayed a previously recorded response for the same idempotency_key instead of applying the write again.

Error cases

confirmation_required

Send confirm: true. A deleted share link cannot be restored.

idempotency_subject_changed

The share changed after the recorded deletion. Issue a new key and re-check the share before writing again.

insufficient_scope

The connection was approved without shares:write.

resource_not_found

No share with that id belongs to this store, or it was already deleted.

Remove a share link

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_share",
    "arguments": {
      "share_id": 512,
      "confirm": true,
      "idempotency_key": "6e0c2f5a-91b4-4d7e-8a3c-5f1d2b9e0a64"
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "share_id": 512,
      "deleted": true,
      "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"
      },
      "idempotent_replay": false
    }
  }
}

Without confirmation nothing is deleted (error)

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_share",
    "arguments": {
      "share_id": 512,
      "confirm": false,
      "idempotency_key": "6e0c2f5a-91b4-4d7e-8a3c-5f1d2b9e0a64"
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "confirmation_required",
        "title": "Confirmation required",
        "detail": "Deleting share 512 stops its link opening the design permanently.",
        "recovery": "This operation changes something consequential. Send confirm: true once the merchant has agreed to it.",
        "parameter": "confirm",
        "allowed_values": [
          "true"
        ]
      }
    }
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.