Invite

Invite an employee

post

Authorizations

happyforceAPIKey

Body

*/*

The details of the employee you want to invite to Happyforce

namestringOptional

Name of the employee

emailstringOptional

Email of the employee

externalIdstringOptional

External id of the employee

hierarchyIdstringOptional

Area id where this employee belongs

Example: 64f8a0e2d5b7c9a1e3f4a5b6

groupIdsstring[]Optional

List of groups to which this user belongs

Example: 64f8a0e2d5b7c9a1e3f4a5b6

rolestring · enumOptional

Role of the employee in the company

Possible values:

managedHierarchiesstring[]Optional

List of hierarchies that this employee manages

Example: 64f8a0e2d5b7c9a1e3f4a5b6

Responses

200

OK

*/*

post

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "profile": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "date": "2025-09-17T10:32:33.887Z",
      "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
    }
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ]
}

200

OK

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": "64f8a0e2d5b7c9a1e3f4a5b6",
  "profile": [
    {
      "id": "64f8a0e2d5b7c9a1e3f4a5b6",
      "date": "2025-09-17T10:32:33.887Z",
      "valueId": "64f8a0e2d5b7c9a1e3f4a5b6"
    }
  ],
  "groupIds": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    "64f8a0e2d5b7c9a1e3f4a5b6"
  ]
}