Skip to main content
PUT
/
v1
/
persons
/
{personId}
/
type
Update person type
curl --request PUT \
  --url https://api.cadanapay.com/v1/persons/{personId}/type \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "newType": "CONTRACTOR",
  "compInfo": {
    "type": "net",
    "frequency": "monthly",
    "employmentModel": "eor"
  }
}
'
{
  "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
​
newType
enum<string>
required

The new employment type for the person

Available options:
EMPLOYEE,
CONTRACTOR
Example:

"CONTRACTOR"

​
compInfo
object

Optional compensation for the new type. If omitted, incompatible compensation is auto-converted (salaried becomes net, fixed becomes net).

Response

Person type updated successfully