Signatures

Correct a draft envelope

Corrects a DRAFT envelope before it is sent: its title, the message the recipients read, the signing order, whether the signed PDF is filed in the Archivio, and its recipients — any of them in one call. Only a draft can be changed; once sent, an envelope can only be voided. signers REPLACES THE WHOLE LIST: pass everybody who should stay, in signing order, not only the person being added (read the list with firme_get_envelope first). Every recipient named here signs through an emailed link; what the web app arranged for the old list (signature boxes on the page, a colleague signing in the app, signing in person) does not carry over. Nobody is contacted: sending is firme_send_envelope, which a person approves.

patch/api/v1/rest/firme/envelopes/{id}

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/firme/envelopes/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The draft envelope id, from firme_create_envelope or firme_list_envelopes.

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
messagestring nullable

Shown to the recipients. null removes it.

routing'sequential' | 'parallel'

sequential invites signers one at a time, in order; parallel all at once.

archive_on_completeboolean

true files the signed PDF in the Archivio once everybody has signed; false keeps it in Firme only.

mail_account_idstring uuid nullable

The organisation mailbox the invitations, reminders and signed copy leave from (an id from email_list_accounts). Omit for the module default.

whatsapp_account_idstring uuid nullable

The WhatsApp number the links, codes and copy are written from (an id from whatsapp_list_accounts). Omit to let the organisation pick.

default_signature_fieldboolean

With signers: a signature box at the foot of the last page for each.

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.