Change the board

Change a SaveHQ custom board

Change a custom board the user made: name, description (public: everyone with the link sees it), instructions (private, only the user sees them: what SaveHQ suggests saves for — for "suggest cocktail bars on Date night", change instructions, not description), who can see it (seePolicy: anyone = public, pinned = pinned saves only, approved = private; joining always needs an invite or the user's approval) and who can add (addPolicy: anyone, approval, owner). Pass only what should change. Opening it up (seePolicy anyone or pinned) needs the user's OK: the first call returns a preview and a confirmToken.

Needs the person's OK: never.

post/api/v1/actions/update_board

Request

  • Base URL: https://savehq.app
  • URL: https://savehq.app/api/v1/actions/update_board
  • Auth: HTTP bearer

Request body

boardIdstring required

A custom board's id exactly as given to you.

namestring
descriptionstring

Public: shown under the name to everyone who opens the link.

instructionsstring

Private, only they see them: what AI suggests saves for, e.g. 'cocktail bars and late-night spots'. Naming one of their tags pulls in that tag's saves.

seePolicy'anyone' | 'pinned' | 'approved'
addPolicy'anyone' | 'approval' | 'owner'
confirmTokenstring

The confirmToken returned with this change's preview, once the user has agreed to it.

Response

Done (status "done", with summary and changeId), or nothing to change

status'done' | 'no_change'
summarystring
changeIdstring
messagestring

Changes

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