Skip to main content
PATCH
/
tenant
/
members
/
{member_id}
Update Member
curl --request PATCH \
  --url http://localhost:8000/tenant/members/{member_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "billing_operator",
  "status": "active"
}
'
{
  "email": "[email protected]",
  "invited_at": "2024-01-01T00:00:00Z",
  "last_login_at": "2024-06-01T12:00:00Z",
  "member_id": "aa0e8400-e29b-41d4-a716-446655440000",
  "name": "Jane Doe",
  "role": "tenant_admin",
  "status": "active",
  "user_id": "bb0e8400-e29b-41d4-a716-446655440000"
}

Headers

​
authorization
string | null
​
x-api-key
string | null
​
x-tenant-id
string | null

Path Parameters

​
member_id
string<uuid>
required

Cookies

​
factio_access_token
string | null

Body

application/json

Schema for updating a tenant member (partial update).

​
role
enum<string> | null

New role for the member

Available options:
platform_admin,
tenant_owner,
tenant_admin,
billing_operator,
accountant,
viewer
​
status
enum<string> | null

New membership status

Available options:
active,
disabled

Response

Successful Response

Schema for a tenant member response.

​
member_id
string<uuid>
required
​
user_id
string<uuid>
required
​
name
string | null
required
​
email
string
required
​
role
string
required
​
status
string
required
​
invited_at
string<date-time> | null
required
​
last_login_at
string<date-time> | null
required