Skip to content

Set domain auto-join

PUT
/api/workspaces/{id}/auto-join
curl --request PUT \
--url http://localhost:8080/api/workspaces/example/auto-join \
--header 'Content-Type: application/json' \
--cookie auth_session=<auth_session> \
--data '{ "domains": [ "example" ], "role": "member" }'
id
required
string
Media typeapplication/json
object
domains
required
Array<string>
<= 20 items
role
string
default: viewer
Allowed values: 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"
}