Happyforce API
  • Welcome
  • Before You Start
  • Data Segmentation in Happyforce
  • API reference
    • Hierarchy
    • Characteristics
    • Groups
    • Scores Metadata
    • Employees
      • Reset
      • Invite
    • Stats
      • Hi
      • Enps
      • Scores
      • Activation
      • Participation
  • Specification
Powered by GitBook
On this page

Was this helpful?

  1. API reference
  2. Employees

Invite

PreviousResetNextStats

Was this helpful?

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
200
OK
*/*
400
Bad Request
*/*
post
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-05-17T05:24:00.994Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}
{
  "name": "text",
  "email": "text",
  "hierarchyId": "text",
  "profile": [
    {
      "id": "text",
      "date": "2025-05-17T05:24:00.994Z",
      "valueId": "text"
    }
  ],
  "groupIds": [
    "text"
  ]
}