Invitation

The Invitation Object enables vendors to create an invite.

Field Name	Data Type	Description
extension	object	The selected extension. Example: { "id": "EXT-1111-1111", "href": "/extensions/EXT-1111-1111-1111", "name": "Adobe Acrobat", "icon": "/static/EXT-1111-1111/logo.png" }
message	string	Invitation message. Example: To proceed with granting you access to the Adobe Acrobat extension, please use the invitation link. You’ll be prompted to redeem a code during installation – this is part of our approval process to ensure secure setup.
validity		Invite validity period. Possible values are: 7d - seven days 1m - one month 3m - tree months 1y - one year Example: { "period": "1m" }
externalId	string	External Id correlated with invitation. Example: 1256-8765-8456
url	string	Invitation code URL. Example: 65221ec9-efa3-4d82-a155-6b01134c1651-3fd6222c-0cc0-4c3d-b128-4ab24f6b7bcc

Example response

 {
    "extension": {
      "id": "EXT-1111-1111",
      "href": "/extensions/EXT-1111-1111-1111",
      "name": "Adobe Acrobat",
      "icon": "/static/EXT-1111-1111/logo.png"
    },
    "message": "To proceed with granting you access to the Adobe Acrobat extension, please use the invitation link. You’ll be prompted to redeem a code during installation – this is part of our approval process to ensure secure setup.",
    "validity": "1m",    
    "externalId": "1256-8765-8456",
    "code": "65221ec9-efa3-4d82-a155-6b01134c1651-3fd6222c-0cc0-4c3d-b128-4ab24f6b7bcc ",
    ""
 }{
    "created": {
      "at": "2024-01-16T21:30:13.1046031",
      "by": {
        "id": "USR-0000-0001"
      }
    },
    "updated": null
  }
}