Document sharing

Prepare a share

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.

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

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Request body

titlestring required
subjectstring required
bodystring
senderKind'mailbox'
accountIdstring uuid nullable
channel'email' | 'whatsapp'
whatsappAccountIdstring uuid nullable
passwordMode'none' | 'shared' | 'generated'
sharedPasswordstring
expiresInDaysinteger nullable
includeHistoryboolean
skipWithoutDocumentsboolean
documentIdsstring[]
ownerUserIdstring uuid

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.