Post a poll

Módulo Workforce

POST/feed-posts/create-pollfeedPosts.createPoll

Posts a quick poll to the feed with 2 to 10 options. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad knowledge.document.write.
Alcances de OAuth: knowledge.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: PollPostRequest

feedPosts.createPoll: PollPostRequest
Campo	Tipo	Obligatorio	Descripción
body	string	Sí	Post text.Restricciones: length 1 to 10000
title	string	No	Optional headline.Restricciones: length 1 to 200
audience_kind	"Organization" \| "Project" \| "Team" \| "Department" \| "Role" \| "Group"	No	Who the row reaches. Department (a canon department, 1365) is for feed posts only.
project_id	string (uuid)	No	Project audience.
team_id	string (uuid)	No	Team audience.
role_id	string (uuid)	No	Role audience.
group_id	string (uuid)	No	Group audience.
department_code	string	No	Canon department code of a Department audience (xpms.dim_department).Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
question	string	Sí	Poll question.Restricciones: length 1 to 300
options	array of string	Sí	2 to 10 options.
allows_multiple	boolean	No	Whether members may pick several.
closes_at	string (date-time)	No	When voting closes.

{
  "body": "Pick the crew meal.",
  "title": "Crew meal",
  "audience_kind": "Organization",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "department_code": "5000",
  "question": "Which crew meal on Saturday?",
  "options": [
    "Tacos",
    "Pasta"
  ],
  "allows_multiple": false,
  "closes_at": "2026-10-08T14:30:00Z"
}

Respuesta 201: FeedPost

feedPosts.createPoll: FeedPost
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the feed post.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Person who last updated the row; null for seed, platform or system writes.
post_kind	"Announcement" \| "Update" \| "Poll" \| "Recognition"	Sí	Post kind; Poll posts come from the createPoll action, Recognition posts from recognitions.
title	string \| null	Sí	Optional headline.Restricciones: length 1 to 200
body	string	Sí	Post text.Restricciones: length 1 to 10000
audience_kind	"Organization" \| "Project" \| "Team" \| "Department" \| "Role" \| "Group"	Sí	Who the row reaches. Department (a canon department, 1365) is for feed posts only.
project_id	string (uuid) \| null	Sí	Identifier of the project audience, or the project the row belongs to.
team_id	string (uuid) \| null	Sí	Identifier of the team audience.
role_id	string (uuid) \| null	Sí	Identifier of the org role audience.
group_id	string (uuid) \| null	Sí	Identifier of the group audience, including department groups.
department_code	string \| null	Sí	Canon department code of a Department audience (xpms.dim_department).Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
author_membership_id	string (uuid) \| null	Sí	Identifier of the member who wrote the post.
pinned_at	string (date-time) \| null	Sí	When the post was pinned; null when not pinned.
requires_acknowledgment	boolean	Sí	Whether every member of the audience must acknowledge it.
reactions_enabled	boolean	Sí	Whether members can react.
comments_enabled	boolean	Sí	Whether members can comment.
publish_at	string (date-time)	Sí	When the post appears; a future time schedules it.
notified_at	string (date-time) \| null	Sí	When the audience was notified.
hidden_at	string (date-time) \| null	Sí	When the post was hidden.
hidden_reason	string \| null	Sí	Why it was hidden.Restricciones: length 1 to 500

{
  "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",
  "post_kind": "Announcement",
  "title": "Wristband change",
  "body": "Wristbands change color on Friday.",
  "audience_kind": "Organization",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "department_code": "5000",
  "author_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "pinned_at": "2026-10-08T14:30:00Z",
  "requires_acknowledgment": false,
  "reactions_enabled": true,
  "comments_enabled": true,
  "publish_at": "2026-10-08T14:30:00Z",
  "notified_at": "2026-10-08T14:30:00Z",
  "hidden_at": "2026-10-08T14:30:00Z",
  "hidden_reason": "Posted to the wrong project."
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/feed-posts/create-poll" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"body":"Pick the crew meal.","title":"Crew meal","audience_kind":"Organization","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","team_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","group_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","department_code":"5000","question":"Which crew meal on Saturday?","options":["Tacos","Pasta"],"allows_multiple":false,"closes_at":"2026-10-08T14:30:00Z"}'

const { data } = await xos.feedPosts.createPoll({
    "body": "Pick the crew meal.",
    "title": "Crew meal",
    "audience_kind": "Organization",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "department_code": "5000",
    "question": "Which crew meal on Saturday?",
    "options": [
      "Tacos",
      "Pasta"
    ],
    "allows_multiple": false,
    "closes_at": "2026-10-08T14:30:00Z"
  });

response = xos.feed_posts.create_poll({"body": "Pick the crew meal.", "title": "Crew meal", "audience_kind": "Organization", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "department_code": "5000", "question": "Which crew meal on Saturday?", "options": ["Tacos", "Pasta"], "allows_multiple": False, "closes_at": "2026-10-08T14:30:00Z"})

xos feed-posts create-poll --data '{"body":"Pick the crew meal.","title":"Crew meal","audience_kind":"Organization","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","team_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","group_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","department_code":"5000","question":"Which crew meal on Saturday?","options":["Tacos","Pasta"],"allows_multiple":false,"closes_at":"2026-10-08T14:30:00Z"}'