Skip to main content
PUT
/
v1
/
persons
/
{personId}
/
jobInfo
Update job information
curl --request PUT \
  --url https://api.cadanapay.com/v1/persons/{personId}/jobInfo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "compInfo": {
    "type": "net",
    "frequency": "monthly",
    "employmentModel": "eor"
  },
  "jobInfo": {
    "startDate": "2023-01-01",
    "employeeNumber": "1",
    "title": "Software Engineer",
    "department": "Product",
    "customFields": [
      {
        "id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
        "name": "Tshirt Size",
        "value": "M"
      }
    ],
    "entityId": "37ad8c1e-0187-4e10-8c54-395e3385b4d2"
  }
}
'
{
  "code": "invalid_request_body",
  "message": "The request body provided is not valid",
  "params": {
    "field": "Value is invalid."
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

​
personId
string<uuid>
required

The unique identifier for the person

Body

application/json

Update person job info request payload

​
compInfo
object

Person's compensation information, how much will they get paid, currency and frequency

​
jobInfo
object

Person's job information, start date, job title, and employee number

Response

Successful operation