Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Staff

Create firm staff member

Creates a staff member in the firm associated with the authenticated client.

post/staff

Request body

userIdstring nullable

Unique identifier of the associated user. Used to map staff member to the specified user id and ignored if left blank. Use the FirmUsers API to remove a staff/user mapping.

titlestring nullable

Staff member's title.

firstNamestring nullable

Staff member's first name.

middleNamestring nullable

Staff member's middle name (if applicable).

lastNamestring nullable

Staff member's last name.

initialsstring nullable

Staff member's initials.

emailstring nullable

Staff member's email address.

rolestring nullable

Staff member's role.

avatarstring nullable

Staff member's avatar.

formerboolean nullable

Whether he/she is a former member.

Caution: Setting a staff member to former staff will also deregister them from the firm.

colorFillstring nullable

Staff member's fill color hex code.

colorStrokestring nullable

Staff member's stroke color hex code.

Example request

{
  "userId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "title": "Mr",
  "firstName": "John",
  "lastName": "Smith",
  "initials": "JS",
  "phone": {
    "areaCode": "555",
    "number": "1234567"
  },
  "cell": {
    "areaCode": "555",
    "number": "1234567"
  },
  "email": "john.smith@brown.com",
  "role": "Bookkeeper",
  "avatar": "https://example-avatar-url.com/image",
  "colorFill": "#797d85",
  "colorStroke": "#64666a"
}

Response

When request is accepted. Returns a hypermedia 'Link' object of the staff member to be created.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable