Class Manager
PUT /v1/staff/{id}

Update Staff

Path parameters

  • id string Required

    Staff id

application/json

Body

Request to update a Staff member

  • firstname string

    Firstname

  • lastname string

    Lastname

  • email string | null

    Staff email

  • permissionSet string

    Values are owner, assistant, manager, or instructor.

  • jobTitle string | null

    Job title

  • joinedAt string(date) | null

    Joined at date

  • phone string | null

    Staff phone

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      id

    • companyId string Required

      Company ID

    • firstname string Required

      First name

    • lastname string Required

      Last name

    • email string | null Required

      Email address

    • phone string | null Required

      Phone number

    • permissionSet string Required

      Values are family, admin, owner, assistant, manager, instructor, or none.

    • jobTitle string | null Required

      Job title

    • invitationStatus string Required

      Values are not_invited, invited, or accepted.

    • archivedAt string(date-time) | null Required

      Archived at date

    • deletedAt string(date-time) | null Required

      Deleted at date

    • joinedAt string(date) | null Required

      Joined at date

    • createdAt string(date-time) | null Required

      Created at date

    • profilePicture string | null Required

      Profile Picture
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 404 application/json

    Not found

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
PUT /v1/staff/{id} 
curl \
 --request PUT 'https://localhost/v1/staff/stf_xxxxxxxx' \
 --header "Content-Type: application/json" \
 --data '{"firstname":"John","lastname":"Doe","email":"john@example.com","permissionSet":"owner","jobTitle":"Teacher","joinedAt":"2024-01-01","phone":"+13124567890"}'
Request examples 
{
  "firstname": "John",
  "lastname": "Doe",
  "email": "john@example.com",
  "permissionSet": "owner",
  "jobTitle": "Teacher",
  "joinedAt": "2024-01-01",
  "phone": "+13124567890"
}
Response examples (200) 
{
  "id": "stf_123123123123",
  "companyId": "co_123123123123",
  "firstname": "John",
  "lastname": "Doe",
  "email": "john@example.com",
  "phone": "(123) 456 7890",
  "permissionSet": "family",
  "jobTitle": "Teacher",
  "invitationStatus": "not_invited",
  "archivedAt": "2023-12-05 14:30:41",
  "deletedAt": "2023-12-05 14:30:41",
  "joinedAt": "2023-12-05",
  "createdAt": "2023-12-05 14:30:41",
  "profilePicture": "https://"
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}