Skip to main content
POST
/
clients
Create Client
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>"
}
'
{
  "id": "uLu8K",
  "client_name": "Acme Corp",
  "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": 123,
  "client_portal_connection_datetime": "<string>",
  "client_portal_invite_datetime": "<string>",
  "client_portal_invite_email": "<string>",
  "pending": true
}
client_name is the only required field. All other fields are optional and can be set later via the Edit Client endpoint.
After creating a client, use the Invite Client endpoint to send them a client portal invitation email.

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Client details. Only 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

Created

​
id
string

Unique client identifier.

Example:

"uLu8K"

​
client_name
string

Client display name.

Example:

"Acme Corp"

​
client_contact_name
string | null

Primary contact name.

​
client_contact_phone
string | null

Primary contact phone number.

​
client_contact_email
string | null

Primary contact email address.

​
client_contact_title
string | null

Primary contact job title.

​
default_comments_for_workers
string | null

Default instructions shown to workers assigned to this client's events.

​
client_invoice_customer_id
string | null

External invoice/customer ID for billing integration.

​
client_address
string | null

Street address.

​
client_city
string | null

City.

​
client_state
string | null

State or province.

​
client_postal_code
string | null

Postal or ZIP code.

​
company_name
string | null

Company name associated with the client.

​
client_portal_connection_status
integer | null

Client portal connection status. 0 = invited, 2 = connected, null = not connected.

​
client_portal_connection_datetime
string | null

Datetime when the client portal was connected.

​
client_portal_invite_datetime
string | null

Datetime when the client portal invitation was sent.

​
client_portal_invite_email
string | null

Email address the client portal invitation was sent to.

​
pending
boolean

Whether the client is in a pending state.