Invite

Invite an employee

post

Authorizations

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

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: 340

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": {
    "timestamp": 1,
    "date": "2025-07-30T19:06:02.812Z"
  },
  "profile": [
    {
      "id": {
        "timestamp": 1,
        "date": "2025-07-30T19:06:02.812Z"
      },
      "date": "2025-07-30T19:06:02.812Z",
      "valueId": {
        "timestamp": 1,
        "date": "2025-07-30T19:06:02.812Z"
      }
    }
  ],
  "groupIds": [
    {
      "timestamp": 1,
      "date": "2025-07-30T19:06:02.812Z"
    }
  ]
}

200

OK

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": {
    "timestamp": 1,
    "date": "2025-07-30T19:06:02.812Z"
  },
  "profile": [
    {
      "id": {
        "timestamp": 1,
        "date": "2025-07-30T19:06:02.812Z"
      },
      "date": "2025-07-30T19:06:02.812Z",
      "valueId": {
        "timestamp": 1,
        "date": "2025-07-30T19:06:02.812Z"
      }
    }
  ],
  "groupIds": [
    {
      "timestamp": 1,
      "date": "2025-07-30T19:06:02.812Z"
    }
  ]
}