headless lms
Communities

Invite a person into a space (staff)

POST /api/communities/{communityId}/spaces/{spaceId}/invites. Invite a person into a space (staff). Headless LMS Communities API reference.

POST
/api/communities/{communityId}/spaces/{spaceId}/invites

Staff only (owner, admin, instructor). Invites a member of the community into a by_invite space; they join when they accept. 403 when the person is staff or does not hold the community; 409 when the space is not invite-only or the person is already placed.

Path Parameters

communityId*string
spaceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/communities/string/spaces/string/invites" \  -H "Content-Type: application/json" \  -d '{    "orgUserId": "string"  }'
{  "orgId": "string",  "id": "string",  "communityId": "string",  "spaceId": "string",  "orgUserId": "string",  "status": "requested",  "source": "request",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}
{  "error": "string",  "message": "string",  "requestId": "string",  "issues": [    {      "path": "string",      "message": "string"    }  ]}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}
{  "error": "string",  "message": "string",  "requestId": "string"}

Add a person to a space (staff) POST

POST /api/communities/{communityId}/spaces/{spaceId}/members. Add a person to a space (staff). Headless LMS Communities API reference.

Approve a person's request to join a space (staff) POST

POST /api/communities/{communityId}/spaces/{spaceId}/members/{orgUserId}/approval. Approve a person's request to join a space (staff). Headless LMS Communities API reference.