Skip to main content
PATCH
Approve request

Path Parameters

organisationId
string
required

Organisation ID

requestId
string
required

Join request ID

Body

application/json
role
enum<string>

Override the role granted on approval; defaults to the role from the original request

Available options:
owner,
provider,
member
Example:

"member"

Response

200 - application/json
id
string
required

Join request ID

Example:

"42"

organisationId
string
required

Key of the organisation

Example:

"org_abc123"

memberId
string | null
required

Key of the requesting member

Example:

"memb_abc123"

memberName
string | null
required

Full name of the requesting member, if available

Example:

"Jane Smith"

memberEmail
string | null
required

Email address of the requesting member, if available

Example:

"jane@example.com"

role
enum<string>
required

Role being requested

Available options:
owner,
provider,
member
Example:

"member"

status
enum<string>
required

Current status of the join request

Available options:
pending,
approved,
declined
Example:

"pending"

createdAt
string<date-time>
required

When the request was created

Example:

"2024-01-15T10:30:00.000Z"

resolvedAt
string<date-time> | null
required

When the request was approved or declined, if resolved

Example:

"2024-01-16T09:00:00.000Z"