Skip to content

Create a feed post

Workforce module

POST/feed-postsfeedPosts.create

A feed post for an audience: an announcement, update, poll or recognition, with pinning, required acknowledgment, reaction and comment switches and a publish time. Creates a feed post. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

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

Request body: FeedPostCreate

feedPosts.create: FeedPostCreate
FieldTypeRequiredDescription
post_kind"Announcement" | "Update" | "Poll" | "Recognition"YesPost kind; Poll posts come from the createPoll action, Recognition posts from recognitions.
titlestring | nullNoOptional headline.Constraints: length 1 to 200
bodystringYesPost text.Constraints: length 1 to 10000
audience_kind"Organization" | "Project" | "Team" | "Department" | "Role" | "Group"YesWho the row reaches. Department (a canon department, 1365) is for feed posts only.
project_idstring (uuid) | nullNoIdentifier of the project audience, or the project the row belongs to.
team_idstring (uuid) | nullNoIdentifier of the team audience.
role_idstring (uuid) | nullNoIdentifier of the org role audience.
group_idstring (uuid) | nullNoIdentifier of the group audience, including department groups.
department_codestring | nullNoCanon department code of a Department audience (xpms.dim_department).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
requires_acknowledgmentbooleanYesWhether every member of the audience must acknowledge it.
reactions_enabledbooleanYesWhether members can react.
comments_enabledbooleanYesWhether members can comment.
publish_atstring (date-time)YesWhen the post appears; a future time schedules it.
{
  "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",
  "requires_acknowledgment": false,
  "reactions_enabled": true,
  "comments_enabled": true,
  "publish_at": "2026-10-08T14:30:00Z"
}

Response 201: FeedPost

feedPosts.create: FeedPost
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the feed post.
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.
post_kind"Announcement" | "Update" | "Poll" | "Recognition"YesPost kind; Poll posts come from the createPoll action, Recognition posts from recognitions.
titlestring | nullYesOptional headline.Constraints: length 1 to 200
bodystringYesPost text.Constraints: length 1 to 10000
audience_kind"Organization" | "Project" | "Team" | "Department" | "Role" | "Group"YesWho the row reaches. Department (a canon department, 1365) is for feed posts only.
project_idstring (uuid) | nullYesIdentifier of the project audience, or the project the row belongs to.
team_idstring (uuid) | nullYesIdentifier of the team audience.
role_idstring (uuid) | nullYesIdentifier of the org role audience.
group_idstring (uuid) | nullYesIdentifier of the group audience, including department groups.
department_codestring | nullYesCanon department code of a Department audience (xpms.dim_department).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
author_membership_idstring (uuid) | nullYesIdentifier of the member who wrote the post.
pinned_atstring (date-time) | nullYesWhen the post was pinned; null when not pinned.
requires_acknowledgmentbooleanYesWhether every member of the audience must acknowledge it.
reactions_enabledbooleanYesWhether members can react.
comments_enabledbooleanYesWhether members can comment.
publish_atstring (date-time)YesWhen the post appears; a future time schedules it.
notified_atstring (date-time) | nullYesWhen the audience was notified.
hidden_atstring (date-time) | nullYesWhen the post was hidden.
hidden_reasonstring | nullYesWhy it was hidden.Constraints: 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."
}

Code samples

curl -X POST "$XOS_BASE_URL/feed-posts" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"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","requires_acknowledgment":false,"reactions_enabled":true,"comments_enabled":true,"publish_at":"2026-10-08T14:30:00Z"}'
const { data } = await xos.feedPosts.create({
    "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",
    "requires_acknowledgment": false,
    "reactions_enabled": true,
    "comments_enabled": true,
    "publish_at": "2026-10-08T14:30:00Z"
  });
response = xos.feed_posts.create({"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", "requires_acknowledgment": False, "reactions_enabled": True, "comments_enabled": True, "publish_at": "2026-10-08T14:30:00Z"})
xos feed-posts create --data '{"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","requires_acknowledgment":false,"reactions_enabled":true,"comments_enabled":true,"publish_at":"2026-10-08T14:30:00Z"}'