Overview
Invites are invitations by an account holder (the inviter) to another user (the invitee) to share their account. An optional role property may determine how the invitee can access the account.
A user who wishes to share an account creates an invite object. The invite contains a linklink, a short encrypted string that can be used to represent the invite. The inviter sends the linklink as a text message to the invitee.
An invitee must claim an account before he/she can use it. When this occurs the invite becomes invalid, and an objectLink is created to represent the sharing connection.
Invite Object
An invite is represented as a JSON object. This table specifies the properties that may be included in this object:
| Property | Description | Schema | Example Values |
|---|---|---|---|
| AFiInviteId | ampliFi ID of the invite | string | "qwekavyuhdturheezbubxgyyrogxkscffnctsvbeuux" |
| AFiUserId | ampliFi ID of the user (inviter) | string | "qweaurl8kgtlv9pc" |
| AFiAccountId | ampliFi ID of the account to be shared | string | "qwegal8kgtmysmels" |
| AFiCardId | ampliFi ID of the card to be shared, if any | string | "qwegal8kgtmysmels" |
| role | Role for invitee when accessing the account | string | "test" |
| familyMemberType | Family member type, if any | string | |
| firstName | First name of invitee | string | "Suzy" |
| lastName | Last name of invitee | string | "Queue" |
| linklink | Link that represents the invite | string | "AAYTXZOUQ" |
| isActive | true if the invite is currently active | boolean | true |
| dtsCreated | Date/time the invite was created | dts | "2023-12-15T12:19:25.561Z" |
| dtsExpiry | Date/time the invite will expire | dts | "2023-12-17T12:19:25.562Z" |
ObjectLink Object
An objectLink is a JSON object representing an invite that has been claimed by the invitee. This links the owner of the account to the user who is sharing it. This table specifies the properties that may be included in this object:
| Property | Description | Schema | Example Values |
|---|---|---|---|
| AFiObjectLinkId | ampliFi ID of the invite | string | "qwekavyuhdturheezbubxgyyrogxkscffnctsvbeuux" |
| AFiInviteId | ampliFi ID of the invite | string | "qwekavyuhdturheezbubxgyyrogxkscffnctsvbeuux" |
| inviterAFiUserId | User ID for the inviter | string | "qweaurl8kgtlv9pc" |
| inviteeAFiUserId | User ID for the invitee | string | "qweaurl11xn6prxj" |
| AFiAccountId | ID of the account being shared | string | "qwegal8kgtmysmels" |
| AFiCardId | ID of the card being shared, if any | string | "qwegal8kgtmysmels" |
| inviteeName | FirstName, middleName, and lastName of the invitee | object | { "firstName": "Suzy", "middleName": "", "lastName": "Queue"} |
| isActive | true if the objectLink is currently active | boolean | true |
| dtsCreated | Date/time when the invite was created | dts | "2023-12-15T12:19:25.561Z" |
| dtsUsed | Date/time when the invite was used (claimed) | dts | "2023-12-17T12:19:25.562Z" |