Skip to main content
PATCH
/
clients
/
{id}
Edit Client
curl --request PATCH \
  --url https://api.roostedhr.com/api/1_12/clients/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "client_name": "<string>",
  "client_contact_name": "<string>",
  "client_contact_email": "<string>",
  "client_invoice_customer_id": "<string>",
  "client_address": "<string>",
  "client_city": "<string>",
  "client_state": "<string>",
  "client_postal_code": "<string>"
}
'
true
client_name is required on every PATCH request, even if you are only updating other fields.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Client ID

Body

application/json

Client fields to update. client_name is required.

​
client_name
string
required
Required string length: 1 - 255
​
client_contact_name
string
Maximum string length: 255
​
client_contact_email
string
Maximum string length: 255
​
client_invoice_customer_id
string
Maximum string length: 255
​
client_address
string
Maximum string length: 65535
​
client_city
string
Maximum string length: 255
​
client_state
string
Maximum string length: 255
​
client_postal_code
string
Maximum string length: 255

Response

OK

The response is of type boolean.