Create a join request

Módulo Identity

POST/join-requestsjoinRequests.create

A request to join an org, approved by an Admin. Creates a join request. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad me.account.write.
Alcances de OAuth: me.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: JoinRequestCreate

joinRequests.create: JoinRequestCreate
Campo	Tipo	Obligatorio	Descripción
person_id	string (uuid)	Sí	Identifier of the requesting person.
message	string \| null	No	Message to the admins.Restricciones: length 1 to 20000

{
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "message": "I run audio for the summer series."
}

Respuesta 201: JoinRequest

joinRequests.create: JoinRequest
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the join request.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
person_id	string (uuid)	Sí	Identifier of the requesting person.
message	string \| null	Sí	Message to the admins.Restricciones: length 1 to 20000
join_request_state	string	Sí	Request state. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
decided_by	string (uuid) \| null	Sí	Identifier 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"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/join-requests" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","message":"I run audio for the summer series."}'

const { data } = await xos.joinRequests.create({
    "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "message": "I run audio for the summer series."
  });

response = xos.join_requests.create({"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "message": "I run audio for the summer series."})

xos join-requests create --data '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","message":"I run audio for the summer series."}'