Skip to main content
PUT
/
staff
/
{id}
Update firm staff member
curl --request PUT \
  --url https://api.smokeball.com/staff/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "userId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "title": "Mr",
  "firstName": "John",
  "middleName": "",
  "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",
  "former": false,
  "colorFill": "#797d85",
  "colorStroke": "#64666a"
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
id
string
required

Body

​
userId
string | null

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.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

​
title
string | null

Staff member's title.

Example:

"Mr"

​
firstName
string | null

Staff member's first name.

Example:

"John"

​
middleName
string | null

Staff member's middle name (if applicable).

Example:

""

​
lastName
string | null

Staff member's last name.

Example:

"Smith"

​
initials
string | null

Staff member's initials.

Example:

"JS"

​
phone
object

Staff member's phone number.

​
cell
object

Staff member's cell number.

​
email
string | null

Staff member's email address.

Example:

"john.smith@brown.com"

​
role
string | null

Staff member's role.

Example:

"Bookkeeper"

​
avatar
string | null

Staff member's avatar.

Example:

"https://example-avatar-url.com/image"

​
former
boolean | null

Whether he/she is a former member.

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

Example:

false

​
colorFill
string | null

Staff member's fill color hex code.

Example:

"#797d85"

​
colorStroke
string | null

Staff member's stroke color hex code.

Example:

"#64666a"

Response

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

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
⌘I