Update workspace invite
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
Authorization
apiKey AuthorizationBearer <token>
The API will use the Authorization: Bearer <your-key> header for requests.
In: header
Path Parameters
inviteId*string
Request Body
application/json
email?|
role?string
Value in
"member" | "admin"maxUses?|
restrictedDomains?array<>|
[key: string]?never
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://api.excalidraw.com/api/v1/workspaces/invites/string" \ -H "Content-Type: application/json" \ -d '{}'{
"id": null,
"created": "string",
"type": "link",
"status": "pending",
"email": "string",
"role": "member",
"resolvedAt": "string",
"redeemedBy": "string",
"maxUses": 9007199254740991,
"uses": 0,
"restrictedDomains": [
"string"
]
}{
"statusCode": 400,
"error": "Bad Request",
"message": "string"
}{
"statusCode": 401,
"error": "Unauthorized",
"message": "string"
}{
"statusCode": 403,
"error": "Forbidden",
"message": "string"
}{
"statusCode": 404,
"error": "Not Found",
"message": "string"
}