InviteObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/argyle9a25/json-schema/argyle9a25-invite-object-schema.json",
  "title": "InviteObject",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/argyle9a25-invites-api-openapi.yml#/components/schemas/InviteObject",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the invite."
    },
    "user": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the user."
    },
    "user_token": {
      "type": "string",
      "description": "[User token](/link/user-tokens) required to initialize embedded instances of Link for the user.\n\n**Warning:**\nThis user token will expire after one hour. A new user token can be created at any time using the [/user-tokens](/api-reference/user-tokens#create) API endpoint.\n"
    },
    "email": {
      "type": "string",
      "description": "Email of the invite recipient."
    },
    "phone_number": {
      "type": "string",
      "description": "Phone number of the invite recipient."
    },
    "full_name": {
      "type": "string",
      "deprecated": true,
      "description": "Full name of the invite recipient."
    },
    "first_name": {
      "type": "string",
      "description": "First name of the invite recipient."
    },
    "last_name": {
      "type": "string",
      "description": "Last name of the invite recipient."
    },
    "revoked_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the invite was revoked."
    },
    "status": {
      "type": "string",
      "enum": [
        "sent",
        "initiated",
        "attempted",
        "completed",
        "revoked"
      ],
      "description": "The invite's status.\n\n- `sent` - Invite sent successfully.\n- `initiated` - User clicked the invite URL and was successfully able to enter Link, but has not submitted login credentials, uploaded documents, or completed a response form.\n- `attempted` - User submitted login credentials through Link (creating a user ID), but no accounts were successfully connected. Also includes users who only submitted a response form.\n- `completed` - User successfully connected an account or uploaded a document.\n- `revoked` - The invite was [revoked](/api-reference/invites#revoke-invite). The user can no longer access Link via the invite URL.\n"
    },
    "group_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "ID of the [group](/console/management/groups) associated with the invite."
    },
    "url": {
      "type": "string",
      "description": "URL included in the invite that connects the user to Link."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the invite was created."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the invite was updated.\n\n**Warning:**\nThe timestamp is updated after re-sending or revoking an invite.\n"
    },
    "invited_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the invite was sent.\n**Warning:**\nThe timestamp is updated after re-sending or revoking an invite.\n"
    },
    "flow_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "ID of the Flow specified via the `flow_id` parameter when sending the invite."
    },
    "flow_items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      },
      "description": "Any Items specified via the `flow_items` parameter when sending the invite."
    },
    "reply_to": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      },
      "description": "Emails of your team members that will be notified when the user has connected their payroll account(s).\n\nDepending on the invite method, these emails are sourced from:\n\n1. If sending invites via the API, the `reply_to` parameter of the `override_invite_template` object.\n2. If sending invites [via Console](/console/flows/email-sms-templates#sending-invites), the Console member that sends the invite and any Cc'd members of your team.\n3. If sending invites via Argyle's POS & LOS integrations ([Encompass](/integrations/pos-los/encompass/payroll-verifications), [Empower](/integrations/pos-los/empower), or [nCino](/integrations/pos-los/ncino)), the email address of the Loan Officer sending the invite.\n4. If sending links to Argyle using [Shareable URLs](/console/flows/shareable-urls), any emails saved in the email notifications toggle of \"General settings\" of the associated [Shareable URL Flow](https://console.argyle.com/flows).\n5. If sending links to Argyle using [Shareable URLs with URL modifications](/console/flows/shareable-urls#url-modifications), the email overwrite specified at the end of the URL.\n"
    },
    "deliveries": {
      "type": "array",
      "description": "Array of objects containing information about the delivery status of the invite.",
      "items": {
        "$ref": "#/$defs/InviteDelivery"
      }
    },
    "invite_template_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "deprecated": true,
      "description": "(Deprecated) Customization ID.\n- Deprecated in favor of [`override_invite_template`](/api-reference/invites#send-override_invite_template)."
    }
  },
  "$defs": {
    "InviteDelivery": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Unique ID of the invite delivery."
        },
        "method": {
          "type": "string",
          "enum": [
            "email",
            "sms"
          ],
          "description": "Invite delivery method."
        },
        "status": {
          "type": "string",
          "enum": [
            "sent",
            "delivered",
            "undelivered",
            "opened"
          ],
          "description": "Status of the invite delivery."
        },
        "sent_at": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the invite was sent."
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the delivery status was last updated."
        }
      }
    }
  }
}