Developer documentation for electronic document signing.

The send endpoint is used when a user sends a new esign. If documentType is 'html' this endpoint should create a draft in the 3rd party system and respond with the document ID. documentType is the value your app returns from /settings ('pdf' or 'html', default 'pdf').

Endpoint
POST https://yourapp.com/send

The endpoint must use HTTPS.

Body
Request body.data contains the information of the file and recipients

body.data.file
The file to send. Use body.data.file.id to download the file from Upsales using the endpoint GET https://integration.upsales.com/api/v2/resources/download/internal/<id>?token=<body.apiKey>. The response body is the raw file.

body.data.involved
An array with the recipients of the esign.

Response
Respond with status 200 or 201. By default, Upsales waits 30 seconds for the response. Any other status, or no response in time, fails the send. To show the user why, include a message property in the JSON error body.

On success, the response has to be a json object with a non-empty documentId property. The documentId will be saved on the esign object in Upsales.

Example response

{
  "documentId": "myEsignId123"
}

Tip when sending
Use the senders design profile to style the webpages and emails related to the esign. You'll fetch the profile with this request GET https://power.upsales.com/api/v2/accountProfile?token=<body.apiKey>