Change the board

Make a SaveHQ custom board

Make a custom board, shared by a link: a name, an optional description (public: shown under the name to everyone who opens the link) and optional instructions (private: only the user sees them; SaveHQ suggests saves that fit them, e.g. "anything tagged ✈️ To Travel, and places to stay in Bali"). People who open the link can ask to join, and people on it add their own saves. Optional itemIds puts saves of the user's on it now (20 or more needs the user's OK). Returns the board id and join_url, the link to send.

Needs the person's OK: 20+ saves.

post/api/v1/actions/create_board

Request

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

Request body

namestring required

e.g. 'Bali trip'.

descriptionstring

Public: shown under the name to everyone who opens the link, e.g. 'Where we're staying and eating in Bali'. Not what suggestions follow.

instructionsstring

Private, only they see them: what AI should suggest for it, e.g. 'places to stay and eat in Bali, and anything tagged ✈️ To Travel' (naming one of their tags pulls in that tag's saves). Left out, suggestions follow the name and description.

itemIdsstring[]

Save ids exactly as given to you.

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.