Invite

Invite an employee for a given email address

post

/v1/public/company/employees/invite

Authorizations

Body

namestring

Name of the employee

emailstring

Email of the employee

hierarchyIdstring

profileobject[]

Entity representing the profile of one of your employees

groupIdsstring[]

List of groups to which this user belongs

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.myhappyforce.com/api/v1/public/company/employees/invite' \
  --header 'happyforceAPIKey: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "name": "text",
    "email": "text",
    "hierarchyId": "text",
    "profile": [
      {
        "id": "text",
        "date": "2025-03-09T02:07:18.230Z",
        "valueId": "text"
      }
    ],
    "groupIds": [
      "text"
    ]
  }'

200

400

200

{
  "name": "text",
  "email": "text",
  "hierarchyId": "text",
  "profile": [
    {
      "id": "text",
      "date": "2025-03-09T02:07:18.230Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}

OK