set_chapter_members
Replace the ordered member list of a chapter.
/v1/chapters/{collectionId}/membersSend the complete desired list in order: [{ spotKey }] entries, or [{ memberCollectionId }] entries to place chapters as cards inside a plain collection. Members not in the list are removed. Atomic.
curl -X PUT "https://sceniq.earth/api/v1/chapters/kn73r7x6mp88mxa9swcbshwd3e7zvr39/members" \
-H "Authorization: Bearer $SCENIQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"members": [
{
"spotKey": "01M2Z1G0Y0R2K5P8S1V4X7Z0C3"
},
{
"spotKey": "01M3H2AWH0F9PB64V7QB8QS0MC"
},
{
"spotKey": "01M3H2AXG8GB8YNF4FCEFARFN5"
},
{
"spotKey": "01M3KMNRY0V8ZPTG4HCY75DZFB"
},
{
"spotKey": "01M3H2AYFG8169CVH0JCQY2BN2"
}
]
}'Path parameters
- collectionIdstring · chapter idrequired
Id of the chapter or collection.
Body parameters
- membersarray of objectsrequired
Ordered list of {
spotKey} or {memberCollectionId} objects, at most 500.Show 2 fieldsHide fields
- spotKeystringoptional
A spot of this guide (
spotKeyfromlist_spots), listed once. Each entry names exactly one ofspotKeyormemberCollectionId. - memberCollectionIdstring · chapter idoptional
A chapter of this guide (kind chapter) shown as a card, listed once. Only a plain collection can hold chapters.
Returns
200 OK with this object.
- okbooleanrequired
Always true: the write went through.
Always
true - collectionIdstring · chapter idrequired
The chapter's or collection's id.
- membersnumberrequired
How many members the chapter now has.
{
"ok": true,
"collectionId": "kn73r7x6mp88mxa9swcbshwd3e7zvr39",
"members": 5
}Errors
Every error is { error: { code, message } }. Act on the code.
- 400invalid_argumentA required field is missing, a field is unknown, or a value does not match its type (the Convex validator's path and value are in the message).
- 400invalid_requestA writer refused a value: a map link on a host that is not allowed, a title that is too long, a date that does not exist, too many items in a list. The message is the writer's own sentence.
- 401unauthenticatedThe request carries no key. Send it as Authorization: Bearer sk_sceniq_... (or X-Api-Key).
- 401invalid_api_keyThe key is unknown, revoked or expired.
- 403api_scope_requiredA read-only key called a write operation, or a key without the publish option called publish_changes.
- 403forbiddenThe key belongs to a creator account that is no longer active.
- 404not_foundThe id does not exist or belongs to another creator. The two answers are identical on purpose, so ids never reveal what exists.
- 413payload_too_largeA JSON body over 2 MB, an image over 6 MB, a batch upload over 19 MB, or an MCP message over 2 MB.
- 429rate_limitedOver a limit: requests per key per minute, per creator per hour, uploads per key per minute, or check_links per guide per hour.
- 500internal_errorAn unexpected failure. The message is hidden on purpose.