---
title: "Prepare a share"
method: POST
path: "/api/v1/rest/condivisione/shares"
tags: ["Document sharing"]
---

# Prepare a share

`POST /api/v1/rest/condivisione/shares`

## Request

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

Create a DRAFT share. `audience`: `roles` (anagrafiche role keys such as cliente or fornitore, from anagrafiche_list_roles), `partyIds` (anagrafiche from anagrafiche_search_parties), `excludedPartyIds`, `emails`. `documentIds`: archive documents every recipient gets. `partyDocuments`: `enabled` (on unless set false) gives each recipient the documents of their own anagrafica: the ones LINKED to it (anagrafiche_link) and, with `includeMatched` (on unless set false), the ones carrying its partita IVA or codice fiscale in their metadata, less a match removed with anagrafiche_remove_match; `sinceDays` only the last N days, `typeIds` only these classes (documents_list_types), `labelIds` only documents carrying one of these Archivio labels (documents_list_labels), `onlyNew` only those never shared with them before. `passwordMode`: none, shared (with `sharedPassword`) or generated (one per recipient, sent separately). `accountId`: the company mailbox it leaves from, from email_list_accounts — a share by mail only ever leaves from one, and cannot be sent without it. `channel`: `email` (the default) or `whatsapp` — then it leaves from the company WhatsApp number `whatsappAccountId` (whatsapp_list_accounts; omit for whichever can send), each recipient gets the link in a WhatsApp chat at their anagrafica’s WhatsApp number, and `audience.phones` takes numbers with no anagrafica, with the international prefix (+39 347 …) instead of `emails`. The message may use {{nome}}, {{azienda}}, {{link}}, {{scadenza}}, {{documenti}}. Nothing is sent: call condivisione_send_share.

## Headers

- `X-Tenant-Id` string, uuid

## Request body

- object
  - `title` string, required
  - `subject` string, required
  - `body` string
  - `senderKind` 'mailbox'
  - `accountId` string, uuid, nullable
  - `channel` 'email' | 'whatsapp'
  - `whatsappAccountId` string, uuid, nullable
  - `passwordMode` 'none' | 'shared' | 'generated'
  - `sharedPassword` string
  - `expiresInDays` integer, nullable
  - `includeHistory` boolean
  - `audience` object
    - `roles` string[]
    - `kind` 'company' | 'person', nullable
    - `partyIds` string[]
    - `excludedPartyIds` string[]
    - `emails` string[]
    - `phones` string[]
  - `partyDocuments` object
    - `enabled` boolean
    - `includeMatched` boolean
    - `sinceDays` integer, nullable
    - `typeIds` string[]
    - `labelIds` string[]
    - `onlyNew` boolean
    - `max` integer
  - `skipWithoutDocuments` boolean
  - `documentIds` string[]
  - `ownerUserId` 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.
- `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)