Change a request before it is sent
update_signature_requestChange a request before anyone gets it: one that waits for review (sent with review: true) before the user clicks Send, or one that waits for the user to sign first. It changes who signs (add, remove or replace people), the signing order, the title, the note to the signer, the markdown text, or where a signature, date or text box sits. Nothing is sent, and the review or signing link stays the same. Give signers as the whole list in the new order, 1 to 5 people; each person keeps their own fields by email, a removed signer's fields go, and a new signer gets a signature block (markdown and Portant's signature page) or the boxes in add_fields (a PDF with placed fields; with none, one signature box on the last page). Portant builds the document again when a printed name, the people or the title changes. Use it only when the user asks for the change, and confirm the new people with the user first. Needs the request_token. fields are usually set from the card in the chat.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | No | The new title. | |
| fields | No | Boxes to move or resize. index is the field number in the document before this change; x, y, width and height are fractions of the page from 0 to 1, measured from the top left. page (from 1) moves the box to another page. When no box is left on Portant's added signature page, Portant removes that page. | |
| message | No | The new note to the signer, up to 500 characters. An empty string removes it. | |
| signers | No | Every signer in the new order, 1 to 5 people. A person with the same email keeps their fields; a new email takes the place of a person left out, in order, and any more are new signers. | |
| markdown | No | Only for a request sent as markdown: the whole document text again, written for the new signers ({{signature:signer}}, then signer2 to signer5). A signer with no signature marker gets a signature block at the end. Text still to fill in, such as [Plan name], is refused. | |
| add_fields | No | Only for a PDF whose fields were placed when it was sent: new boxes, usually for a new signer. signer is the position in the new order, from 1; page is from 1; x, y, width and height are fractions of the page from the top left. | |
| request_id | No | ||
| request_token | Yes | ||
| allow_placeholders | No | Pass true only when the user confirms the square brackets in the new markdown are meant to be in the document. |