Uploads

Upload and archive a document

Upload an already signed file to the document archive / contract management to make it searchable and to use it in your contract management process.

Use either file_ids to reference a file from Upload a file, file_content to send the document as a base64 encoded string, or a multipart post with the file parameter. Only one file source can be provided per request.

A successful request returns the archived document details in document, as in Get a document but without recipients, together with entity.

post/v1/upload/archive

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/upload/archive
  • Auth: HTTP bearer

Request body

file_idsstring

File id of a previously uploaded file, see Upload a file. Only the first id of a comma separated list is used.

file_namestring

Filename of the archived document, with the extension

file_urlstring

Url to the file. The file must be available for download without any authorization. It is always downloaded over https://, also when the URL starts with http://.

file_contentstring

Send the file as base64 encoded. Note that base64 encoding files will increase the file size by about 30%

namestring

Name of the document

typestring

Document type identifier, such as sales, hr, introduction or other.

tagsstring

Comma separated tag titles. A title that matches an existing tag of the entity reuses it; any other title creates a new tag.

contract_start_datestring

Start date of the contract for contract management. ISO 8601 (for example 2024-01-31 or 2024-01-31T10:00:00+00:00), yyyy-MM-dd HH:mm:ss, RFC 2822 and common US date formats are accepted, and a value without an offset is read as UTC.

contract_end_datestring

End date of the contract for contract management. ISO 8601 (for example 2024-01-31 or 2024-01-31T10:00:00+00:00), yyyy-MM-dd HH:mm:ss, RFC 2822 and common US date formats are accepted, and a value without an offset is read as UTC.

sign_datestring

Date and time when the document was signed. ISO 8601 (for example 2024-01-31 or 2024-01-31T10:00:00+00:00), yyyy-MM-dd HH:mm:ss, RFC 2822 and common US date formats are accepted, and a value without an offset is read as UTC. A value that cannot be read answers 400.

company_namestring

Associated company

company_numberstring

Associated company number

sender_idstring

Id of the user to set as the sender and owner of the document

sender_emailstring

Email of the user to own the archived document, which takes precedence over sender_id.

datastring

JSON encoded object used by the Zapier integration. On a multipart request from Zapier, file_url, file_content and file_name are read from it instead of the form fields; every other field is still read from the form.

filestring binary

Response

The request succeeded.

Changes

No recorded changes to this operation across all 1 revision of this API.