Update a Staff Member

PUT

/businesses/{businessId}/staff/{staffId}

const url = 'https://api.upvio.com/v1/businesses/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/staff/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","email":"example","timezone":"UTC"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://api.upvio.com/v1/businesses/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/staff/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "email": "example", "timezone": "UTC" }'

Authorizations

apiKey

Parameters

Path Parameters

businessId

required

string format: uuid

Business ID

staffId

required

string format: uuid

Staff ID

Request Body

application/json

object

name

string

email

string

timezone

Timezone string.

string

nullable

Example

UTC

Responses

200

The updated Staff member

application/json

Staff

A user within a Business that can use and/or manage resources.

object

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

nullable

name

required

The full legal name of the staff member.

string

status

required

The status of the staff member. Only ACTIVE staff can be booked.

string

Allowed values: ACTIVE DISABLED ARCHIVED PENDING_INVITE NOT_INVITED

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

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

nullable

Example

{
  "alias": "john",
  "name": "John Doe",
  "status": "ACTIVE",
  "bookingURL": "https://forms.upvio.com/book/acme/staff/123",
  "roles": [
    "ADMIN"
  ],
  "timezone": "UTC"
}

400

The staff ID is malformed, the staff data is invalid, or the staff member has been archived.

application/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: BadRequestError StaffArchivedError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 400,
    "type": "StaffArchivedError",
    "title": "Operation unavailable on archived staff."
  }
}

403

The API key is missing or invalid, or the Business cannot be accessed with it.

application/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: UnauthorizedError BusinessArchivedError BusinessDisabledError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 403,
    "type": "UnauthorizedError",
    "title": "Invalid API token"
  }
}

404

The staff member does not exist.

application/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: NotFoundError BusinessNotFoundError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 404,
    "type": "NotFoundError",
    "title": "Staff with ID {staffId} not found"
  }
}