Skip to main content
POST
/
clients
/
{id}
/
invite
Invite Client by Email
curl --request POST \
  --url https://api.roostedhr.com/api/1_12/clients/{id}/invite \
  --header 'X-API-KEY: <api-key>'
true

Documentation Index

Fetch the complete documentation index at: https://docs.roostedhr.com/llms.txt

Use this file to discover all available pages before exploring further.

No request body is needed. The invitation is sent to the client’s existing client_contact_email address. Make sure this field is set before calling this endpoint.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required

Client ID

Response

OK

The response is of type boolean.