Staff

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}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/staff/{id}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

idstring required

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.