Update a StaffMember

put

https://api.vcita.biz/v3/business_administration/staff_members/{uid}

Overview

Update a StaffMember.

Available for Staff Token

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uid

string

required

The unique identifier of the staff member. Must be a valid uid from an existing staff member.

Body Params

first_name

string

The first name of the staff member.

last_name

string | null

The last name of the staff member.

display_name

string | null

The display name of the staff member used for public facing interfaces.

string

The email address of the staff member.

professional_title

string | null

The professional title of the staff member (e.g., "Senior Consultant", "Medical Director").

country_name

string | null

The country name for the staff member's mobile number (e.g., "United States", "United Kingdom").

mobile_number

string | null

The mobile number of the staff member without country code (e.g., "2345678901").

photo_url

string | null

The URL to the staff member's profile photo.

default_homepage

string | null

enum

Default homepage when the staff member logs in. When null, the system default is used.

Allowed:

email_signature

string | null

The email signature of the staff member.

Responses

400

Invalid request parameters

401

Unauthorized

403

Forbidden

404

Staff member not found

409

Email already in use by another staff member

500

Internal server error

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Staff member updated successfully