---
title: "Stop a share"
method: POST
path: "/api/v1/rest/condivisione/shares/{id}/cancel"
tags: ["Document sharing"]
---

# Stop a share

`POST /api/v1/rest/condivisione/shares/{id}/cancel`

## Request

- Base URL: `https://api.custodo.ai`
- URL: `https://api.custodo.ai/api/v1/rest/condivisione/shares/{id}/cancel`
- Auth: HTTP bearer

Call off a planned share, or stop one that is sending: whoever has not been written to yet is not. Links already sent keep working — to take those back, use condivisione_withdraw_share.

**Examples**

- Stop that share
  `POST /api/v1/rest/condivisione/shares/11111111-2222-4333-8444-555555555555/cancel`

## Path parameters

- `id` string, uuid, required

## Headers

- `X-Tenant-Id` string, uuid

## Response `200`

Done. `data` is the tool’s own answer.

- RestResult
  - `ok` true, required
  - `data` unknown, required

## Other responses

- `400`: The arguments did not validate: `error.message` names the field, what it expects and what arrived.
- `401`: No API key, or one that is malformed, unknown, revoked or expired.
- `403`: The call never ran: the module is off for this organisation, the credential lacks the permission or the module, the tier does not cover it, or the tool is destructive and the key was not minted for that.
- `404`: Nothing with that id in this organisation.
- `409`: The record is in a state that does not allow it — under legal hold, already sent, already closed. `error.code` says which.
- `422`: The tool ran and refused, in a sentence of its own (`TOOL_REFUSED`): the message says what to change. Retrying the same call will not help.
- `429`: The API key has spent its minute, or its day. Every request a key makes counts. See `Retry-After`.

---

[API](https://skmtc.dev/custodo/apis/custodo-integrazioni.md) · [All operations](https://skmtc.dev/custodo/apis/custodo-integrazioni/llms.txt) · [OpenAPI document](https://skmtc.dev/custodo/apis/custodo-integrazioni/revisions/16d336d3ec2a?raw)