Skip to content

Approve a join request

Identity module

POST/join-requests/{id}/approvejoinRequests.approve

Approves the request and creates the membership. Requires an Admin. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability org.members.invite.
  • OAuth scopes: org.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

joinRequests.approve: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the join request.

Response 200: JoinRequest

joinRequests.approve: JoinRequest
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the join request.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
person_idstring (uuid)YesIdentifier of the requesting person.
messagestring | nullYesMessage to the admins.Constraints: length 1 to 20000
join_request_statestringYesRequest state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$
decided_bystring (uuid) | nullYesIdentifier of the deciding admin.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "message": "I run audio for the summer series.",
  "join_request_state": "Proposed",
  "decided_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X POST "$XOS_BASE_URL/join-requests/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/approve" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
const { data } = await xos.joinRequests.approve("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.join_requests.approve("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos join-requests approve 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f