InviteResult

Result of sending a single invitation

  • object
    Type: string

    Resource type identifier

  • email
    Type: string

    Email address the invitation was sent to

  • success
    Type: boolean

    Whether this invitation was sent successfully

  • invitation
    Type: object ยท Invitation

    Invitation details and current state

    • object
      Type: string

      Resource type identifier

    • id
      Type: string

      Unique invitation identifier

    • email
      Type: string

      Email address the invitation was sent to

    • state
      Type: string

      Current state: pending, accepted, expired, or revoked

    • role_slugs
      Type: array string[]

      Roles assigned to the invitee upon acceptance (system + custom)

    • expires_at
      Type: string

      When the invitation expires

    • created_at
      Type: string

      When the invitation was created

  • error
    Type: string

    Error message (present when success is false)