Skip to main content
PUT
/
v1
/
collaborators
/
{id}
Update collaborator
curl --request PUT \
  --url https://api.capitalcheckin.app/v1/collaborators/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "position": "<string>",
  "department": "<string>",
  "status": "active",
  "role": "admin",
  "hire_date": "2023-12-25",
  "salary": 123,
  "manager_id": "<string>",
  "work_schedule": "<string>",
  "location": "<string>",
  "emergency_contact": {
    "name": "<string>",
    "phone": "<string>",
    "relationship": "<string>"
  }
}
'
{
  "id": "<string>",
  "name": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "position": "<string>",
  "department": "<string>",
  "status": "active",
  "role": "admin",
  "hire_date": "2023-12-25",
  "salary": 123,
  "manager_id": "<string>",
  "work_schedule": "<string>",
  "location": "<string>",
  "avatar_url": "<string>",
  "emergency_contact": {
    "name": "<string>",
    "phone": "<string>",
    "relationship": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

OAuth2 access token for authentication

Path Parameters

id
string
required

Collaborator ID

Body

application/json
name
string

Full name of the collaborator

Minimum string length: 2
email
string<email>

Email address (must be unique)

phone
string

Phone number

position
string

Job position or title

department
string

Department or team

status
enum<string>

Collaborator status

Available options:
active,
inactive,
pending
role
enum<string>

Collaborator role

Available options:
admin,
manager,
employee
hire_date
string<date>

Date when collaborator was hired

salary
number

Annual salary

manager_id
string

ID of the manager

work_schedule
string

Work schedule (full-time, part-time, etc.)

location
string

Work location

emergency_contact
object

Response

Collaborator updated

id
string

Unique collaborator identifier

name
string

Full name of the collaborator

email
string<email>

Email address

phone
string

Phone number

position
string

Job position or title

department
string

Department or team

status
enum<string>

Collaborator status

Available options:
active,
inactive,
pending
role
enum<string>

Collaborator role

Available options:
admin,
manager,
employee
hire_date
string<date>

Date when collaborator was hired

salary
number

Annual salary

manager_id
string

ID of the manager

work_schedule
string

Work schedule (full-time, part-time, etc.)

location
string

Work location

avatar_url
string<uri>

Profile picture URL

emergency_contact
object
created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp