Create a Staff Member
Deprecated
POST /businesses/{businessId}/staff
POST
/businesses/{businessId}/staff
Create a Staff Member
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” businessId
required
string format: uuid
Business ID
Request Body
Section titled “Request Body ”object
name
required
string
email
required
string
Responses
Section titled “ Responses ”The created Staff Member
object
data
Staff
A user within a Business that can use and/or manage resources.
object
id
required
Unique identifier across the platform.
string format: uuid
createdAt
Time when the resource was created (ISO 8601 format).
string format: date-time
updatedAt
Time when the resource was created (ISO 8601 format).
string format: date-time
businessId
The ID of the Business this resource belongs to.
string format: uuid
email
required
Unique Email Address that the Staff uses to login.
string format: email
alias
An optional unique alias for the Staff member.
string
Example
john name
required
The full legal name of the staff member.
string
Example
John Doe status
required
The status of the staff member. Only ACTIVE staff can be booked.
string
enabled
required
Deprecated - Use status instead. Returns true when status is ACTIVE.
boolean
bookingURL
The URL where patients can book this staff member directly.
string
Example
https://forms.upvio.com/book/acme/staff/123 roles
required
A list of roles assigned to the Staff.
Array<string>
managedStaffIds
A list of Staff IDs that are managed by this Staff.
Array<string>
timezone
Timezone string.
string
Example
UTC