invites

Resend Workspace Invite

View as Markdown
Resend a pending workspace invite with extended expiry

Path parameters

invite_idintegerRequired

Response

Invite resent successfully
idintegerRead-only
tokenstringRead-onlyformat: "uuid"
Unique token for invite identification
emailstringRead-onlyformat: "email"
Email address of the person being invited
roleenum

Role to assign when invite is accepted

  • 1 - Viewer
  • 2 - Editor
  • 3 - Admin
  • 4 - Owner
Allowed values:
role_displaystringRead-only

Get human-readable role name.

Args: obj: The model instance being serialized (typically WorkspaceInvite)

Returns: str: The human-readable role name, or “UNKNOWN” if not found

statusenum

Current status of the invitation

  • pending - Pending
  • accepted - Accepted
  • cancelled - Cancelled
  • expired - Expired
Allowed values:
messagestringRead-only
Optional message from the inviter
created_atdatetimeRead-only
expires_atdatetimeRead-only
When this invite expires
accepted_atdatetime or nullRead-only
When the invite was accepted
invited_by_emailstringRead-onlyformat: "email"
workspace_namestringRead-only
is_expiredbooleanRead-only

Check if invite is expired.

Args: obj: The model instance being serialized (typically WorkspaceInvite)

Returns: bool: True if the invite is expired, False otherwise

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error