Update a staff member

PUT /api/v1/client/{client_uuid}/staff-members/{uuid}
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • client_uuid string Required

    uuid The UUID of the business client.

  • uuid integer Required
  • id string Required

    uuid The UUID of the client that is a staff member.

application/json

Body

  • hired_at date

    Date (y-m-d) of when the staff member was hired.

  • left_at date

    Date (y-m-d) of when the staff member left.

  • job_title string

    The job title of the staff member.

  • basic_annual_salary integer

    The basic annual salary of the staff member. Must be in pennies, for example: £50,000 would be 5000000.

  • payroll_number string

    The payroll number of the staff member.
PUT /api/v1/client/{client_uuid}/staff-members/{uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/staff-members/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"hired_at":"2018-01-15","left_at":"2025-01-15","job_title":"Chief Coffee Maker","basic_annual_salary":5000000,"payroll_number":"#12345"}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "hired_at": "2018-01-15",
  "left_at": "2025-01-15",
  "job_title": "Chief Coffee Maker",
  "basic_annual_salary": 5000000,
  "payroll_number": "#12345"
}