Skip to content

addDocument

Deprecated

This endpoint will stop working on 1 August 2027. Migrate to POST /v1/jobs/{id}/documents in the new API; the migration guide has the recommended order of work and the important model differences.

Upload flow has changed - legacy /rest/docs/addDocuments accepted metadata-only and required the file to be POSTed separately. New API returns a presigned S3 upload URL from POST /v1/jobs/{id}/documents which the client must then PUT the file to within 10 seconds. Legacy supported site-level documents in the same call (level: "S"); for site-level use POST /v1/sites/{id}/documents instead.

Open POST /v1/jobs/{id}/documents in the new API →

View legacy reference
/rest/docs/addDocuments

POST
Create Documents

All fields below are mandatory with the exception of the Synopsis tag

Level has to be set to one of the following:
  • J : if document is set at job level
  • S : if document is set at Site level


{
  "docs" : [
    {
      "jobRef" : "J00X7U",
      "jobClientRef" : "",
      "clientId" : "",
      "filename" : "A File.doc",
      "title" : "Document Title",
      "synopsis" : "document Synopsis",
      "size" : "728",
      "categoryId" : "11",
      "type" : "jpg",
      "level" : "J" 
    } 
  ]
}

See the Document API matrix for the full list of endpoints in this category.