Update member role API Reference

PATCH

/tenants/{tenant}/members/{email}

curl --request PATCH \
  --url https://api.kupe.cloud/api/v1/tenants/acme/members/alice%2540acme.com \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --header 'If-Match: 184920' \
  --data '{ "role": "readonly" }'

Change the role of an existing tenant member. Roles control access: admin has full read-write access, readonly can only view resources.

Authorizations

• BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

email

required

string

Member email address (URL-encoded)

Header Parameters

If-Match

string

ETag for optimistic locking

Request Body

New role

Media type application/json

object

role

string

Example

readonly

Responses

200

Updated member

Media type application/json

object

email

string

role

string

Example

{
  "email": "alice@acme.com",
  "role": "admin"
}

400

Validation error

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

401

Missing or invalid authentication

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

403

Admin access required

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

404

Member not found

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

412

ETag mismatch

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

429

Rate limit exceeded

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}