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

Responses

200

OK

*/*

400

Bad Request

*/*

post

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "email": "text",
  "hierarchyId": {
    "timestamp": 1,
    "date": "2025-06-27T10:48:08.744Z"
  },
  "profile": [
    {
      "id": {
        "timestamp": 1,
        "date": "2025-06-27T10:48:08.744Z"
      },
      "date": "2025-06-27T10:48:08.744Z",
      "valueId": {
        "timestamp": 1,
        "date": "2025-06-27T10:48:08.744Z"
      }
    }
  ],
  "groupIds": [
    {
      "timestamp": 1,
      "date": "2025-06-27T10:48:08.744Z"
    }
  ]
}

{
  "name": "text",
  "email": "text",
  "hierarchyId": {
    "timestamp": 1,
    "date": "2025-06-27T10:48:08.744Z"
  },
  "profile": [
    {
      "id": {
        "timestamp": 1,
        "date": "2025-06-27T10:48:08.744Z"
      },
      "date": "2025-06-27T10:48:08.744Z",
      "valueId": {
        "timestamp": 1,
        "date": "2025-06-27T10:48:08.744Z"
      }
    }
  ],
  "groupIds": [
    {
      "timestamp": 1,
      "date": "2025-06-27T10:48:08.744Z"
    }
  ]
}