Docs

The Backend Invitation object

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

Properties

  • Name
    id
    Type
    string
    Description

    A unique identifier for the Invitation.

  • Name
    emailAddress
    Type
    string
    Description

    The email address that the invitation was sent to.

  • Name
    publicMetadata
    Type
    {[string]: any}
    Description

    Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API .

  • Name
    createdAt
    Type
    number
    Description

    Date when the Invitation was first created.

  • Name
    updatedAt
    Type
    number
    Description

    Date of the last time the Invitation was updated.

  • Name
    status
    Type
    'pending' | 'accepted' | 'revoked'
    Description

    The status of the Invitation.

  • Name
    revoked?
    Type
    boolean
    Description

    Whether the Invitation has been revoked.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on