Skip to content

Update Member Role

PATCH
/appointments/membership/by-user/{user_id}/role

Change someone’s SCHEDULING role. Admin keys only.

This decides what they can do in scheduling, not in graph8 generally - organisation roles live in Settings and are not reachable from here.

Authorizations

Parameters

Path Parameters

user_id
required

The member’s INTEGER scheduling user id - user_id from GET /appointments/membership. Not a PropelAuth id or an email.

integer

The member’s INTEGER scheduling user id - user_id from GET /appointments/membership. Not a PropelAuth id or an email.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A member’s SCHEDULING role - not their graph8 organisation role.

object
role
required
string
Allowed values: ADMIN MEMBER

Responses

200

Successful Response

object
data
required

An open envelope for a filter, a setting, an embed config or a slot grid.

Open because org settings gain branding fields as the booking page does and the embed config gains styling keys as the widget does. Closing it would drop a field the app had already started returning.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string