API Reference
Status PageRoadmapTestimoniesShare feedback
  1. electronic signature
  2. Signature Request

Activate a Signature Request

post
https://api-sandbox.yousign.app/v3/signature_requests//activate

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.

When the Signature Request is set to be archived on Y (archiving is archive_y), activation fails with a 400 error of type configuration.archive_y_identifier_required if no archive Y identifier is configured on its workspace or, as a fallback, on its organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

ℹ️ A Signature Request must contain at least one Document, one Signer and one Field of type signature to be activated.

Related guide: Signature Request

🔓 Endpoint access

  • Environments: production, sandbox
  • API key scopes: organization, workspace
  • Plans: plus, pro, scale
  • Add-ons (for production access): Signature or Advanced E-Signature or Qualified Electronic Signature
Path Params
uuid
required

Signature Request Id

Body Params
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.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 5 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago