Create a staff member

POST /api/v1/client/{client_uuid}/staff-members

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • client_uuid string Required
application/json

Body Required

  • account_uuid string Required

    UUID of another client account in Plannr. This account must be an individual.

  • hired_at date Required

    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.

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
POST /api/v1/client/{client_uuid}/staff-members
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/staff-members' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"account_uuid":"a216685b-3f2d-4371-9828-7f70346f4c71","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
{
  "account_uuid": "a216685b-3f2d-4371-9828-7f70346f4c71",
  "hired_at": "2018-01-15",
  "left_at": "2025-01-15",
  "job_title": "Chief Coffee Maker",
  "basic_annual_salary": 5000000,
  "payroll_number": "#12345"
}
Response examples (401)
{
  "message": "Unauthenticated."
}