v1

latestOpenAPI 3.0.32026-08-061810496.7 KB

Signature requests

Create signature request

post/api/1/folders/{folder_ID}/sign_requests

Request body

labelstring required

Label of signature request.

templateinteger

ID of signature request template.

remindersinteger[]

Positive integers for days after the request is sent; negative integers for days before the due date

due_atstring nullable

Sets the due date to. Used for the status, and sending reminders

filesinteger[] required

IDs of files requested to be signed

orderedboolean

Set to true to respect signing order. Defaults to false.

reassignboolean

Set to true to enable reassignments of signers. A signer can delegate signing to another user. Defaults to false.

Example request

{
  "label": "My new signature request",
  "template": 16,
  "reminders": [
    16
  ],
  "due_at": "architecto",
  "roles": [
    []
  ],
  "files": [
    16
  ]
}

Response

Idinteger

@typestring

@idstring

Labelstring

PackageIdstring

activated_atstring nullable

completed_atstring nullable

cancelled_atstring nullable

created_atstring

archived_atstring nullable

Linkstring

OrderedSigningboolean

Reassignmentboolean

UsingTemplateboolean

folderstring nullable

due_atstring nullable

Example response

{
  "Id": 32,
  "@type": "SignRequest",
  "@id": "sr_32",
  "Label": "Signature request for February 17th, 2025",
  "PackageId": "CyLDjVMX1BUh6KeRm9XYTERK77Q=",
  "activated_at": null,
  "completed_at": null,
  "cancelled_at": null,
  "created_at": "2025-02-17T19:24:57.000000Z",
  "archived_at": null,
  "Link": "/sign/32",
  "OrderedSigning": true,
  "Reassignment": true,
  "UsingTemplate": false,
  "folder": null,
  "due_at": null
}