Skip to content

Add a workspace member

POST
/api/workspaces/{id}/members
curl --request POST \
--url http://localhost:8080/api/workspaces/example/members \
--header 'Content-Type: application/json' \
--cookie auth_session=<auth_session> \
--data '{ "userId": "example", "role": "admin" }'
id
required
string
Media typeapplication/json
object
userId
required
string
role
required
string
Allowed values: admin member viewer

Successful response

Media typeapplication/json
object
success

Whether the request succeeded.

boolean
data

Endpoint-specific response payload.

message
string
error
string

Example

{
"message": "Operation completed",
"error": "Error message"
}

Invalid request

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}

Internal server error

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}