Update a workspace update

PATCH

/workspaces/:workspaceId/updates/:updateId

PATCH

/workspaces/:workspaceId/updates/:updateId

$ curl -X PATCH https://api.getpostman.com/workspaces/1f0df51a-8658-4ee8-a2a1-d2567dfa09a9/updates/123 \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "description": "We'\''ve released the first version of our newest API!",
>   "topic": "API v1.0 released",
>   "category": "announcement",
>   "isPinned": true,
>   "relatedResources": [
>     {
>       "resource": "collection",
>       "resourceId": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"
>     }
>   ]
> }'

1 {
2   "id": 1,
3   "topic": "API v1.0 released",
4   "description": "We've released the first version of our newest API!",
5   "workspaceId": "1f0df51a-8658-4ee8-a2a1-d2567dfa09a9",
6   "createdBy": 12345678,
7   "updatedBy": 12345678,
8   "createdAt": "2026-04-10T09:36:21.000Z",
9   "updatedAt": "2026-04-10T11:58:43.000Z",
10   "category": "announcement",
11   "isPinned": true,
12   "relatedResources": [
13     {
14       "resource": "collection",
15       "resourceId": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"
16     }
17   ]
18 }

Updates a workspace update.

Note:

This endpoint requires the application/merge-patch+json Content-Type header.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

workspaceIdstringRequired

The workspace's ID.

updateIdintegerRequired

The workspace update's ID.

Request

This endpoint expects an object.

descriptionstringRequired1-20000 characters

The content of the workspace update.

topicstringRequired1-255 characters

The title of the workspace update.

categoryenumRequired

The update's assigned category.

isPinnedbooleanOptionalDefaults to false

If true, the workspace update is pinned to the top of the workspace updates list.

relatedResourceslist of objectsOptional

A list containing the update's related elements. Related elements include links to collections, requests, folders, and saved examples in the update.

Response

Successful Response

idinteger

The workspace update's ID.

topicstring

The title of the workspace update.

descriptionstring

The content of the workspace update.

workspaceIdstring

The ID of the workspace in which the workspace update was created.

createdByinteger

The user ID of the user that created the workspace update.

updatedByinteger

The ID of the user who last updated the workspace update.

createdAtdatetime

The date and time at which the workspace update was created.

updatedAtdatetime

The date and time at which the workspace update was last updated.

categoryenum

The update's assigned category.

isPinnedbooleanDefaults to false

If true, the workspace update is pinned to the top of the workspace updates list.

relatedResourceslist of objects

A list containing the update's related elements. Related elements include links to collections, requests, folders, and saved examples in the update.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error