Skip to content

ChangeMemberRole

PUT
/api/v1/t/{tenant}/members/{userId}/role
curl --request PUT \
--url https://example.com/api/v1/t/example/members/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/role \
--header 'Content-Type: application/json' \
--data '{ "roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
tenant
required
string

Tenant slug

userId
required
string format: uuid
Media typeapplication/json
object
roleId
required
string format: uuid
Examplegenerated
{
"roleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

OK

Media typeapplication/json
object
userId
required
string format: uuid
email
required
string
displayName
required
string
roleId
required
string format: uuid
roleName
required
string
roleKey
required
null | string
status
required
Allowed values: Active Removed
joinedAt
required
string format: date-time
Example
{
"status": "Active"
}

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"errors": {
"additionalProperty": [
"example"
]
}
}

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}