Document collection

Open a document collection

Creates a DRAFT raccolta: which archive document types to ask for (call documents_list_types for ids and names), how the requests go out — by EMAIL from an active mailbox of the mail module (account_id + account_address), or on WHATSAPP from one of the organisation’s numbers (channel: "whatsapp", optional whatsapp_account_id from whatsapp_list_accounts; the customer answers in the chat with a photo or the PDF) — an optional due date and reminder cadence, and optionally the recipients (an email, a whatsapp number, or both: the channel decides which one is needed). Nothing is sent until raccolta_send_collection. The subject and body accept {{nome}}, {{azienda}}, {{documenti}}, {{scadenza}}, {{codice}}, {{mittente}}.

post/api/v1/rest/raccolta/collections

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/raccolta/collections
  • 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

namestring required
channel'email' | 'whatsapp'

email (the default) or whatsapp.

account_idstring uuid

The mailbox id, from email_list_accounts. Required by email.

account_addressstring email

That mailbox’s address. Required by email.

whatsapp_account_idstring uuid

The WhatsApp number the requests leave from (whatsapp_list_accounts).

subject_templatestring
body_templatestring
reminder_every_daysinteger
reminder_maxinteger
due_onstring date

YYYY-MM-DD

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.