Pin or unpin a post
Workforce module
POST/feed-posts/{id}/pinfeedPosts.pin
Pins the post to the top of the feed, or unpins it. Needs knowledge.sop.publish or org.communication.write. 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.publish.
- 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
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the feed post. |
Request body: PinFeedPostRequest
| Field | Type | Required | Description |
|---|---|---|---|
| pinned | boolean | Yes | Pinned. |
{
"pinned": true
}Response 200: FeedPost
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the feed post. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| post_kind | "Announcement" | "Update" | "Poll" | "Recognition" | Yes | Post kind; Poll posts come from the createPoll action, Recognition posts from recognitions. |
| title | string | null | Yes | Optional headline.Constraints: length 1 to 200 |
| body | string | Yes | Post text.Constraints: length 1 to 10000 |
| audience_kind | "Organization" | "Project" | "Team" | "Department" | "Role" | "Group" | Yes | Who the row reaches. Department (a canon department, 1365) is for feed posts only. |
| project_id | string (uuid) | null | Yes | Identifier of the project audience, or the project the row belongs to. |
| team_id | string (uuid) | null | Yes | Identifier of the team audience. |
| role_id | string (uuid) | null | Yes | Identifier of the org role audience. |
| group_id | string (uuid) | null | Yes | Identifier of the group audience, including department groups. |
| department_code | string | null | Yes | Canon department code of a Department audience (xpms.dim_department).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| author_membership_id | string (uuid) | null | Yes | Identifier of the member who wrote the post. |
| pinned_at | string (date-time) | null | Yes | When the post was pinned; null when not pinned. |
| requires_acknowledgment | boolean | Yes | Whether every member of the audience must acknowledge it. |
| reactions_enabled | boolean | Yes | Whether members can react. |
| comments_enabled | boolean | Yes | Whether members can comment. |
| publish_at | string (date-time) | Yes | When the post appears; a future time schedules it. |
| notified_at | string (date-time) | null | Yes | When the audience was notified. |
| hidden_at | string (date-time) | null | Yes | When the post was hidden. |
| hidden_reason | string | null | Yes | Why 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/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/pin" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"pinned":true}'const { data } = await xos.feedPosts.pin("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"pinned": true
});response = xos.feed_posts.pin("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"pinned": True})xos feed-posts pin 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"pinned":true}'