API Reference

Update employment

patch
https://api.oysterhr.com/v0.1/hiring/employments/

This API endpoint allows you to update a draft employment record and receive a complete response with the updated details.

This endpoint requires the X-Oyster-Actor-Email header when using client credentials authentication.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Employment ID

Body Params
string
length between 1 and 3

ISO 3166-2 subdivision code. Not editable for employments in the United States (US) or Canada (CA) because these countries have subdivision-specific agreements.

manager
object
role
object
personalDetails
object
compensation
object
signer
object
Responses

404

Resource does not exist, or no permission to access resource

Updated 3 days ago

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

Updated 3 days ago