Skip to content

Vote in a poll

Workforce module

POST/polls/{id}/votepolls.vote

Votes once: one option, or several when the poll allows it. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability knowledge.sop.acknowledge.
  • OAuth scopes: knowledge.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

polls.vote: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the poll.

Request body: PollVoteRequest

polls.vote: PollVoteRequest
FieldTypeRequiredDescription
option_idsarray of string (uuid)YesOptions chosen.
{
  "option_ids": [
    "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  ]
}

Response 200: Poll

polls.vote: Poll
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the poll.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesPerson who last updated the row; null for seed, platform or system writes.
feed_post_idstring (uuid)YesIdentifier of the feed post.
questionstringYesQuestion.Constraints: length 1 to 300
allows_multiplebooleanYesWhether members may pick several options.
closes_atstring (date-time) | nullYesWhen voting closes.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "feed_post_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "question": "Which crew meal on Saturday?",
  "allows_multiple": false,
  "closes_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/polls/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/vote" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"option_ids":["0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"]}'
const { data } = await xos.polls.vote("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "option_ids": [
      "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
    ]
  });
response = xos.polls.vote("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"option_ids": ["0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"]})
xos polls vote 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"option_ids":["0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"]}'