Archive a sign request

Sign Requests can be archived. The API exposes an Archive Sign Request endpoint to achieve this:

Archive a sign request endpoint

Below is the end point used for archive sign requests.

HTTP
Copy

Example

A complete example of how to archive a sign request can be found below.

Javascript
Copy
ParameterDescription
Authorization (header)Your API Key is required on all calls to the API and should be sent as a bearer token.
Content-Type (header)application/json
Body (body)Archiving a Sign Request requires you to send a status of "ARCHIVED" in the body of your request {``"status": "ARCHIVED"``}
sign_request_id (path)This is a UUID referring to the Sign Request you are looking to archive. This will be the UUID obtained from the Create Sign Request endpoint

The Archive Sign Request endpoint returns a status code of 200 if successful.

Other response codes

ResponseDescription
400The API returns a 400 if the parameter sent to it is incorrect. You may only send a status of 'ARCHIVED' or the request will be unsuccessful.
401401 is returned if a request is unauthorised. This is likely due to the API Key either being incorrect or not being sent properly in the headers. The key should be sent as a Bearer token over the authorisation header.
404If the request is not found you will receive a 404. This will be due to the request ID being invalid.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard