Skip to main content
Docs

The Backend Invitation object

The Backend Invitation object represents an invitation to join your application.

Properties

  • Name
    createdAt
    Type
    number
    Description

    The date when the Invitation was first created.

  • Name
    emailAddress
    Type
    string
    Description

    The email address that the invitation was sent to.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the Invitation.

  • Name
    publicMetadata
    Type
    null | Record<string, unknown>
    Description

    MetadataJavaScript Icon that can be read from the Frontend API and Backend API and can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.

  • Name
    revoked?
    Type
    boolean
    Description

    Whether the Invitation has been revoked.

  • Name
    status
    Type
    "expired" | "revoked" | "pending" | "accepted"
    Description

    The status of the Invitation.

  • Name
    updatedAt
    Type
    number
    Description

    The date when the Invitation was last updated.

  • Name
    url?
    Type
    string
    Description

    The URL that the user can use to accept the invitation.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub