Docs

The Backend OrganizationInvitation object

The Backend OrganizationInvitation object is similar to the OrganizationInvitation object as it is the model around an organization invitation. However, the Backend OrganizationInvitation object is different in that it is used in the Backend API and is not directly accessible from the Frontend API.

Properties

  • Name
    id
    Type
    string
    Description

    A unique identifier for the invitation.

  • Name
    emailAddress
    Type
    string
    Description

    The email address of the user who is invited to the Organization.

  • Name
    role
    Type
    string
    Description

    The role of the invited user.

  • Name
    organizationId
    Type
    string
    Description

    The ID of the Organization that the user is invited to.

  • 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
    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
    privateMetadata
    Type
    {[string]: any}
    Description

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

Feedback

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

Last updated on