Change the board

Delete a SaveHQ category

Delete one of the user's categories. Its saves are never deleted. With moveTo (another of their categories, by id or name) its saves move into that category first, as in a merge: none is doubled, and the deleted name still finds them in search. Without moveTo they stay on the board: any also in another category stay there, the rest become uncategorized. Needs the user's OK: the first call returns a preview, which says how many saves the category has and where they'll go, and a confirmToken. One undo_change brings the category back with its saves as they were.

Needs the person's OK: always.

post/api/v1/actions/delete_category

Request

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

Request body

categoryIdstring required

A category id exactly as given to you.

moveTostring

Optional: the category to move its saves into before it's deleted, by id or by name (e.g. 'Recipes').

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.