Public API v1

Cast / update / clear a vote on a destination option.

post/v1/trips/{id}/variants/{variantId}/votes/options

Request

  • Base URL: https://api.mynextadventure.cloud (the document declares no server; this is the origin it was published from)
  • URL: https://api.mynextadventure.cloud/v1/trips/{id}/variants/{variantId}/votes/options
  • Auth: API key in header X-API-Key

Path parameters

idstring required
variantIdstring required

Request body

destinationKeystring required

Destination key the option belongs to.

optionKeystring required

Option key inside the destination.

value'up' | 'down' | 'clear' required

Vote direction. 'clear' removes the caller's existing vote.

Response

votedboolean required

True if a vote was cast or updated; false if it was cleared.

value'up' | 'down' | 'clear' required

Echo of the requested value for confirmation.

Changes

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