POST
/
staff
Create firm staff member
curl --request POST \
  --url https://api.smokeball.com/staff \
  --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

Body

Response

202
application/json

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

The response is of type object.