Create Client

This endpoint serves the purpose of creating a client.

POST /clients

Create Client

cURL

curl --request POST \
  --url https://api.roostedhr.com/api/1_12/clients \
  --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>"
}
'

200

{
  "id": "<string>",
  "client_name": "<string>",
  "client_contact_name": "<string>",
  "client_contact_phone": "<string>",
  "client_contact_email": "<string>",
  "client_contact_title": "<string>",
  "default_comments_for_workers": "<string>",
  "client_invoice_customer_id": "<string>",
  "client_address": "<string>",
  "client_city": "<string>",
  "client_state": "<string>",
  "client_postal_code": "<string>",
  "company_name": "<string>",
  "client_portal_connection_status": 0,
  "client_portal_connection_datetime": "<string>",
  "client_portal_invite_datetime": "<string>",
  "client_portal_invite_email": "<string>",
  "pending": true
}

Authorizations

X-API-KEY · string · header · required

Body

application/json

Client Object

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

200

application/json

OK

id · string

client_name · string

client_contact_name · string | null

client_contact_phone · string | null

client_contact_email · string | null

client_contact_title · string | null

default_comments_for_workers · string | null

client_invoice_customer_id · string | null

client_address · string | null

client_city · string | null

client_state · string | null

client_postal_code · string | null

company_name · string | null

client_portal_connection_status · integer | null

Required range: 0 <= x <= 1

client_portal_connection_datetime · string | null

client_portal_invite_datetime · string | null

client_portal_invite_email · string | null

pending · boolean