Deletes a firm staff member

Sets the staff member from the firm associated with the authenticated client as a former staff member.

The staff member is set as a former staff member and if they are a user, becomes a former user. User access is also disabled.

DELETE /staff/{id}

Deletes a firm staff member

cURL

curl --request DELETE \
  --url https://api.smokeball.com/staff/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

202

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

id · string · required

Response

202

application/json

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

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET