/employees/:id/documents

post https://{subdomain}.workable.com/spi/v3/employees/{id}/documents

Uploads a list of documents for a specific employee. Required scope: w_employees.

🚧
This particular endpoint uses w_employees scope, which can be enabled through the Integrations section found within the Settings menu.

Body

{
    "documents": [
        {
            "url": "https://cdn.mos.cms.futurecdn.net/HjFE8NKWuCmgfHCcndJ3rK.jpg",
            "name": "Custom document"
        }
    ]
}

key	type	description
url	`string`	Complete URL where the file/document is hosted or stored. TTL 1 hour
name	`string`	Name of the file/document

Calling the /employees/:id/documents POST endpoint will create a collection of documents associated with an employee.

Responses

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://subdomain.workable.com/spi/v3/employees/id/documents \
3
     --header 'Authorization: Bearer' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

🚧This particular endpoint uses w_employees scope, which can be enabled through the Integrations section found within the Settings menu.

Body

201201

400400

🚧
This particular endpoint uses `w_employees` scope, which can be enabled through the Integrations section found within the Settings menu.