v1
Guide

Update a guide

Updates editable fields of a specific guide (group, status, share state, linked URL, meta, hidden expressions). Only owners may update.

put/api/v1/guide

Request

  • Base URL: https://app.serpmantics.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.serpmantics.com/api/v1/guide
  • Auth: HTTP bearer

Query parameters

idstring required

The ID of the guide to update

Request body

groupstring

Group/folder the guide belongs to (triggers cannibalisation analysis on previous and new group)

status'' | 'draft' | 'active' | 'review' | 'published' | 'archived'

Editorial status of the guide. Empty string clears the status.

shareState'private' | 'shared-read' | 'shared-edit'

Sharing mode. Any value outside the enum is rejected with 400 (the check is case-sensitive). Plan must allow shared-read or shared-edit, otherwise 403 is returned.

linkedUrlstring uri

Public URL where the guide content is published (validated as URL)

hiddenExpressionsstring[]

Expressions to hide from the optimisation suggestions

Response

Guide successfully updated. When shareState was part of the update, data.shareState echoes the state that was requested, validated and persisted by this call.

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.