Invite

Invite an employee for a given email address

post

Authorizations

Body

The details of the employee you want to invite to Happyforce

namestringOptional

Name of the employee

emailstringOptional

Email of the employee

hierarchyIdstringOptional

groupIdsstring[]Optional

List of groups to which this user belongs

Responses

post

HTTPcURLJavaScriptPython

POST /api/v1/public/company/employees/invite HTTP/1.1
Host: api.myhappyforce.com
happyforceAPIKey: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 148

{
  "name": "text",
  "email": "text",
  "hierarchyId": "text",
  "profile": [
    {
      "id": "text",
      "date": "2025-04-26T11:21:04.446Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}

{
  "name": "text",
  "email": "text",
  "hierarchyId": "text",
  "profile": [
    {
      "id": "text",
      "date": "2025-04-26T11:21:04.446Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}