DevelopersAPI referenceSignPublic links
Edit a draft, reconfigure publish settings, or pause/resume
Owner-scoped. name/recipients/fields/visitorSlotIndex are editable only while status is "draft" — once published, nothing else can concurrently change what an already-shared link produces, so a content edit post-publish is rejected (409); unpublish first. expiresAt/maxSubmissions/oneSubmissionPerEmail and status (active/paused) are editable at any time. Resuming a paused link re-mints its token: the pre-pause URL never quietly comes back to life, and "url" is included in that response only.
View as MarkdownAuthorization
bearer AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/public-signing/string" \ -H "Content-Type: application/json" \ -d '{}'{ "publicSigningLink": { "id": "string", "name": "string", "status": "draft", "hasFile": true, "pages": 0, "recipients": [ { "name": "string", "role": "string", "orderIndex": 0, "isGroup": true, "groupLabel": "string" } ], "fields": [ { "type": "signature", "x": 0, "y": 0, "width": 0, "height": 0, "page": 0, "required": true, "label": "string", "recipientIndex": 0, "key": "string", "config": {} } ], "visitorSlotIndex": 0, "expiresAt": "2019-08-24T14:15:22Z", "maxSubmissions": 0, "submissionCount": 0, "oneSubmissionPerEmail": true, "publishedAt": "2019-08-24T14:15:22Z", "pausedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "url": "string" }}