v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Documents

Upload file from a URL to a Shared Folder

Use this endpoint to upload a file from a specified URL directly into a shared folder of a specific employee in Bob. <br><br>Make sure you set the right permissions to the Service User in order to upload the file. See more details in <a href="https://help.hibob.com/hc/en-us/articles/4409792096273-Create-a-document-folder#h_01HDNE82T44QA6632JB9ZGPZ6G">How to set up permissions for People's Docs </a>.

post/docs/people/{id}/shared

Path parameters

idstring required

The ID of the Employee. You can obtain the employee ID from the employee data.

Request body

documentNamestring

The name of the Document.

documentUrlstring

The URL pointing to the document to upload.

tagsstring[]

A array of tags that you want to attach to the document in Bob.

Response

Uploaded document details.

idnumber

The ID (docId) of the document that was created. Use this when you need to pass the docID to other endpoints.

employeeIdstring

The employee ID that the document was uploaded for.

uploadedByIdstring

The ID of the service user that performed the upload

namestring

The name of the document.

creationDatestring

The timestamp for the upload.

statusstring

The status of the document.

tagsstring[]

Document tags in Bob are custom labels that you can assign to your documents to organize and filter them according to your own criteria.

folderIdnumber

The backend-id of the folder the document was uploaded to.

mimeTypestring

The file type

fileIdnumber

The backend-id of the updloaded file.

documentNamestring

The name of the document.

actionRequestDatestring
actionCompleteDatestring