Reset

Resets the employee profile for a given email address, allowing the employee to select a new are and profile when they log in on the app

put
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

rolestring · enumOptional

Role of the employee in the company

Possible values:
Responses
200

OK

put
PUT /v1/public/company/employees/reset HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": {
    "timestamp": 1,
    "date": "2025-08-29T17:36:20.753Z"
  },
  "profile": [
    {
      "id": {
        "timestamp": 1,
        "date": "2025-08-29T17:36:20.753Z"
      },
      "date": "2025-08-29T17:36:20.753Z",
      "valueId": {
        "timestamp": 1,
        "date": "2025-08-29T17:36:20.753Z"
      }
    }
  ],
  "groupIds": [
    {
      "timestamp": 1,
      "date": "2025-08-29T17:36:20.753Z"
    }
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    {
      "timestamp": 1,
      "date": "2025-08-29T17:36:20.753Z"
    }
  ]
}
200

OK

{
  "name": "text",
  "email": "text",
  "externalId": "text",
  "hierarchyId": {
    "timestamp": 1,
    "date": "2025-08-29T17:36:20.753Z"
  },
  "profile": [
    {
      "id": {
        "timestamp": 1,
        "date": "2025-08-29T17:36:20.753Z"
      },
      "date": "2025-08-29T17:36:20.753Z",
      "valueId": {
        "timestamp": 1,
        "date": "2025-08-29T17:36:20.753Z"
      }
    }
  ],
  "groupIds": [
    {
      "timestamp": 1,
      "date": "2025-08-29T17:36:20.753Z"
    }
  ],
  "role": "ADVISOR",
  "managedHierarchies": [
    {
      "timestamp": 1,
      "date": "2025-08-29T17:36:20.753Z"
    }
  ]
}

Last updated

Was this helpful?