Skip to content

Members endpoints

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

Parameter In Type Required
workspaceId path string (uuid) yes
Status Meaning Body
200 OK MembersResponse

POST /api/workspaces/{workspaceId}/members

Section titled “POST /api/workspaces/{workspaceId}/members”
Parameter In Type Required
workspaceId path string (uuid) yes

Request body (application/json): InviteMemberRequest

Field Type Required Notes
userId string or null yes
role string yes
email string or null no
Status Meaning Body
200 OK none

PATCH /api/workspaces/{workspaceId}/members/{memberUserId}

Section titled “PATCH /api/workspaces/{workspaceId}/members/{memberUserId}”
Parameter In Type Required
workspaceId path string (uuid) yes
memberUserId path string yes

Request body (application/json): ChangeMemberRoleRequest

Field Type Required Notes
role string yes
Status Meaning Body
200 OK MembershipDto

DELETE /api/workspaces/{workspaceId}/members/{memberUserId}

Section titled “DELETE /api/workspaces/{workspaceId}/members/{memberUserId}”
Parameter In Type Required
workspaceId path string (uuid) yes
memberUserId path string yes
Status Meaning Body
200 OK none