Change the board

Add a comment to a SaveHQ save

Add a note to one of the user's saves, or to any save on a custom board they're on. Notes start private (only the user sees them). public true shows it to everyone who can see the save; tag (person ids from get_save) lets those people read it and tells them in about 15 seconds. Either needs the user's OK: the first call returns a preview and a confirmToken.

Needs the person's OK: making it public.

post/api/v1/actions/add_comment

Request

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

Request body

itemIdstring required
textstring required
publicboolean
tagstring[]

Person ids from get_save's “can tag” list.

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.