Firm

Update firm user mapping

Updates a user mapping in the firm associated with the authenticated client.

put/firmusers/{id}

Request

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

Path parameters

idstring required

Request body

userIdstring nullable

Unique identifier of the associated user.

staffIdstring nullable

Unique identifier of the associated staff member..

Example request

{
  "userId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "staffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"
}

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

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