Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Signature Request

Activate a Signature Request

Activates a Signature request, so it is not in draft status anymore. If the delivery_mode is not null, activating the Signature Request will trigger the notifications to Approvers/Followers/Signers.

post/signature_requests/{signatureRequestId}/activate

Path parameters

signatureRequestIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Signature Request Id

Request body

sender_idstring uuid

The Id of the User that should be considered as the Signature Request sender. They must be part of the Workspace of the Signature Request and be active. Mandatory with sender_type: "user", must be omitted otherwise.

Example request

{
  "sender_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c"
}

Response

The Signature Request has been activated

idstring required
status'ongoing' | 'approval' required
namestring required
delivery_mode'email' | 'none' required
created_atstring date-time required
activated_atstring date-time nullable required

Timestamp indicating when the Signature Request was activated and made available to its recipients.
Returns null if the Signature Request is still in draft.

completed_atstring date-time nullable required

Timestamp indicating when the Signature Request reached the done status, i.e. all required Signers have signed and all Approvers have approved.
Returns null if the Signature Request is not yet complete.

approved_atstring date-time nullable required

Timestamp indicating when all Approvers have approved the Signature Request when custom recipient flow is not enabled.
Returns null if no approvers are configured, or if at least one approver has not yet approved, or when custom_recipient_order is enabled.

ordered_signersboolean required

Enable an ordered workflow, each Signer will be requested to sign in a sequential order

ordered_approversboolean required

Enable an ordered workflow, each Approver will be requested to approve in a sequential order

timezonestring required

Time zone of the dates and times displayed in emails, the Signature Request expiration date, and the PDF Audit Trail. Format: tz database. Default is set to Europe/Paris.

email_custom_notestring nullable required
expiration_datestring date-time required
external_idstring nullable required
branding_idstring uuid nullable required
custom_experience_idstring uuid nullable required
audit_trail_locale'de' | 'en' | 'es' | 'fr' | 'it' | 'pt' | 'ro' required
signers_allowed_to_declineboolean required
workflow_session_idstring uuid nullable required

Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.

previous_attempt_idstring uuid nullable required

ID of the previous attempt within the same workflow_session_id. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.

custom_recipient_orderboolean required

Enable a custom recipients order

Example response

{
  "id": "89120884-d29a-4b1a-ac7b-a9e73a872795",
  "name": "signature request name",
  "created_at": "2024-01-18T22:59:00Z",
  "activated_at": "2024-01-18T22:59:00Z",
  "completed_at": "2024-01-18T22:59:00Z",
  "approved_at": "2024-01-18T22:59:00Z",
  "ordered_signers": true,
  "ordered_approvers": true,
  "timezone": "Europe/Paris",
  "email_custom_note": "Please sign these documents as soon as possible.",
  "expiration_date": "2024-01-18T22:59:00Z",
  "signers": [
    {
      "signature_link_expiration_date": "2024-01-18T22:59:00Z"
    }
  ],
  "approvers": [
    {
      "approval_link_expiration_date": "2024-01-18T22:59:00Z"
    }
  ],
  "labels": [
    {
      "id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
      "name": "Contracts"
    }
  ],
  "branding_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "custom_experience_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "audit_trail_locale": "en",
  "rejection_information": {
    "approver_id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
    "reason": "I don't agree with the terms in the document.",
    "rejected_at": "2024-01-18T22:59:00Z"
  },
  "workflow_session_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "previous_attempt_id": "9412b83b-b4b9-4a94-97b5-2b43dfa4cde4"
}