Upload a Document

Uploads a document to the profile page of the specified talent record. Uploaded document displays on the Documents tab of the talent profile page.

Path Params
string
required

The identifier for the talent.

Body Params
int32

The identifier for the talent document that will be generated by Avionté.

int32

The identifier for the talent.

string
length ≤ 255

The encrypted name of the file with extension that is generated by Avionté.

file

The content of the file to be uploaded. It will be populated using the content of the attached file. Valid file extensions are: 'txt', 'doc', 'docx', 'pdf', 'xls', 'xlsx', 'png', 'jpg', 'jpeg'.

string
length ≤ 500

The title of the document taken from the attached file.

date-time

The date when the document was uploaded. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

string
length ≤ 50

The type of the BOLD document.

int32

The ID of the user uploading the document.

boolean

An indication of whether the document is private or not.

boolean

An indication of whether the document is shared or not.

date-time

The expiration date of the document. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.

int32

The identifier for the BOLD document type.

int32

The identifier for the employer.

boolean

An indication of whether the document is visible or not.

string

The contents of the talent document as a Base-64 encoded string returned after file upload.

file
required

The file to upload.

Headers
uuid

Unique request identifier (GUID) used to correlate request data with log entries and events.

integer

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

string

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Responses

401

Unauthorized

403

Access Denied

405

Unsupported method

406

Unsupported format(s) indicated by Accept header

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

504

Gateway Timeout

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json