headless lms
Communities

Reorder the links in a space (staff)

PUT /api/communities/{communityId}/spaces/{spaceId}/links/order. Reorder the links in a space (staff). Headless LMS Communities API reference.

PUT
/api/communities/{communityId}/spaces/{spaceId}/links/order

Owner or admin only. Send every link id of the space exactly once (409 otherwise).

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 PUT "https://example.com/api/communities/string/spaces/string/links/order" \  -H "Content-Type: application/json" \  -d '{    "ids": [      "string"    ]  }'
{  "orgId": "string",  "id": "string",  "communityId": "string",  "name": "string",  "description": "string",  "seq": -9007199254740991,  "accessRule": "all_members",  "capacity": -9007199254740991,  "settings": {    "comments": true,    "reactions": true,    "requireReview": true  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "topics": [    {      "orgId": "string",      "id": "string",      "spaceId": "string",      "name": "string",      "seq": -9007199254740991,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "links": [    {      "orgId": "string",      "id": "string",      "spaceId": "string",      "contentId": "string",      "seq": -9007199254740991,      "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"}

Remove a link from a space (staff) DELETE

DELETE /api/communities/{communityId}/spaces/{spaceId}/links/{linkId}. Remove a link from a space (staff). Headless LMS Communities API reference.

List the people who hold a community (staff) GET

GET /api/communities/{communityId}/members. List the people who hold a community (staff). Headless LMS Communities API reference.