Change the board

Invite people to a SaveHQ custom board

Invite people who follow the user, or whom the user follows, onto a custom board the user made (get_custom_board lists them as can_invite). They get an invite to accept by email and in the app; nobody is added until they accept. Always needs the user's OK: the first call returns a preview and a confirmToken.

Needs the person's OK: always.

post/api/v1/actions/invite_to_board

Request

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

Request body

boardIdstring required

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

personIdsstring[] required

Person ids from get_custom_board's can_invite 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.