API Reference

Update a client

patch
https://api.firmcheck.com/clients/

Update a client. Only provided fields will be updated. Cannot modify the underlying entity (individual/organisation/soleTrader).

Path Params
string
required

The unique identifier for the client.

Body Params

Body

Fields to update for a client. Only provided fields will be updated. Cannot modify the underlying entity (individual/organisation/soleTrader).

string
enum

The relationship status of your client.

Allowed:
serviceIds
array of strings

The IDs of the services that this client is receiving.

serviceIds
string | null

A reference to a staff member.

string | null

A reference to a staff member.

string | null

A reference to a business unit.

string | null

Your unique reference number.

string | null

The date of the next review for this client in ISO-8601 format (YYYY-MM-DD).

Headers
string
enum
required
Allowed:
Responses

404

404

500

500

Updated 7 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago