Invitation

Invitations are used to invite other users to access an existing Employer

Name / Description Type / Format Example
employer
The Employer that the invite relates to
Item {Item}
emailAddress
The email address of the user that is being invited to access the Employer
string "string"
message
An optional message to include in the email sent to the EmailAddress
string "string"
role string "Admin" "Editor" "Reviewer"
emailId string uuid "string"
emailStatus string "Queued" "Sent" "Failed" "Processing"
invitedBy
Details of the User that created the invitations
Item {Item}
id
The unique id of the object
string uuid "string"
{
  "employer": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "emailAddress": "string",
  "message": "string",
  "role": "Admin",
  "emailId": "string",
  "emailStatus": "Queued",
  "invitedBy": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "id": "string"
}
Contained in Models

- none -

Consumed by Operations
Create Invitation
Returned by Operations
Get Invitation