EXexcalidraw
workspace
invites

Create invite

Changed on

Create a new invite for the workspace.

You can create:
- Email-based invites (send to a specific email)
- Invite links (with optional restrictions and usage limits)

**Use cases:**
- Inviting new members to the workspace
- Generating invite links for onboarding
- Automating team invitations
post/api/v1/workspaces/invites

Request

  • Base URL
    https://api.excalidraw.com
  • URL
    https://api.excalidraw.com/api/v1/workspaces/invites
  • Auth
    HTTP bearer

Request body

OR

Response

This response returns the details of the newly created workspace invite.

idstring required
createdstring required
type'link' | 'email' required
status'pending' | 'redeemed' | 'rejected' required
emailunknown required
role'member' | 'admin' required
resolvedAtunknown required
redeemedByunknown required
usesnumber
restrictedDomainsstring[]

Changes

  • 9fa65a47c84cRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • warning

      changed the pattern of the request property / from ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ to ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

    • info

      response property email list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property redeemedBy list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property resolvedAt list-of-types was narrowed by removing types null from media type application/json of response 200