Skip to content
Bottle

Change a member's role

PATCH
/members/{userId}
curl --request PATCH \
  --url https://example.com/members/example \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "role": "owner" }'

Owners may set any role. Admins may not touch an owner, nor promote anyone to owner. The last owner cannot be demoted, so a tenant always has someone who can administer it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
userId
required
string
>= 1 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
role
required

Owner: billing, deleting the tenant, full control of members. admin: all operational work and may manage drivers and admins. driver: their own round only.

string
Allowed values: owner admin driver

Responses

Section titled “Responses”

200

Section titled “200”

Updated

Media typeapplication/json
object
user
required
object
id
required
string
email
required
string format: email
firstName
required
string
lastName
required
string
name
required
string
emailVerified
required
boolean
twoFactorEnabled
required
boolean
twoFactorMethod
required
string | null
Allowed values: totp otp
image
required
string | null
role
required

Owner: billing, deleting the tenant, full control of members. admin: all operational work and may manage drivers and admins. driver: their own round only.

string
Allowed values: owner admin driver
joinedAt
required
string format: date-time
Example
{
  "user": {
    "id": "kZ8n2xQpR1vLmT4wY7bJc",
    "email": "joe.bloggs@example.com",
    "firstName": "Joe",
    "lastName": "Bloggs",
    "name": "Joe Bloggs",
    "twoFactorMethod": "totp"
  },
  "role": "owner"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or the role is not allowed to do this

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not a member

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

Would leave the tenant without an owner

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}