EXexcalidraw
workspace
invites

Update workspace invite

Changed on

Update the metadata of a specific workspace invite by its ID.

You can update:
- Email address (for email invites)
- Role assigned to the invitee
- Maximum uses or domain restrictions

**Use cases:**
- Correcting invite details
- Changing invite permissions
- Managing invite limits
patch/api/v1/workspaces/invites/{inviteId}

Request

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

Path parameters

inviteIdstring required

Request body

emailunknown
role'member' | 'admin'
restrictedDomainsstring[]

Response

This response returns the updated data for the 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

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

    • 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

    • info

      the request property became nullable

    • 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