v1

latestOpenAPI 3.1.02026-07-1276185442.2 KB

Applications

Documents

Upload Application Document

post/unified/ats/applications/{id}/documents/upload

Path parameters

idstring required

Headers

x-account-idstring required

The account identifier

Request body

namestring nullable

The filename of the file to upload

contentstring nullable

The base64 encoded content of the file to upload

category_idstring nullable

The categoryId of the documents

pathstring nullable

The path for the file to be uploaded to

Example request

{
  "name": "weather-forecast",
  "file_format": {
    "value": "pdf"
  },
  "content": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE",
  "category_id": "6530",
  "path": "/path/to/file",
  "confidential": {
    "value": "true"
  },
  "category": {
    "value": "resume",
    "source_value": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Response

The document related to the application with the given identifier was uploaded.

statusCodenumber nullable

messagestring nullable

timestampstring date-time nullable

Example response

{
  "statusCode": 201,
  "message": "Employee created successfully",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.someprovider.com/v1/endpoint",
      "raw": {
        "error": "Bad Request",
        "message": "The supplied data is invalid"
      },
      "headers": {
        "date": "Tue, 02 Apr 2024 13:52:01 GMT",
        "content-type": "application/json; charset=utf-8",
        "transfer-encoding": "chunked",
        "connection": "close"
      }
    }
  ],
  "unified_warnings": [
    {
      "message": "The provided field type is not supported in the current model."
    }
  ]
}