Skip to main content
PATCH
/
v1
/
announcements
/
{announcementId}
Update an announcement
curl --request PATCH \
  --url https://{host}/v2/workspaces/slug:ai-governance-v2/webhooks/v1/announcements/{announcementId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "summary": "<string>",
  "content": "<string>",
  "icon": "<string>",
  "link": "<string>",
  "targets": {},
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "updated": true
}

Authorizations

​
Authorization
string
header
required

User-bound credential carrying an identity: either a session JWT or a user access token (at:*) generated from the user settings UI. Send as Authorization: Bearer <token>. Org API keys (iak_*) are not accepted here - they carry no user identity. Use the x-prismeai-api-key header instead (see OrgApiKeyAuth).

Path Parameters

​
announcementId
string
required

Announcement identifier.

Maximum string length: 64
Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json
​
title
string
Maximum string length: 500
​
summary
string
Maximum string length: 2000
​
content
string
Maximum string length: 50000
​
icon
string
Maximum string length: 256
​
link
string
Maximum string length: 2048
​
targets
object

Audience targeting object - re-validated when provided.

​
status
enum<string>
Available options:
draft,
active,
archived
Maximum string length: 32
​
expires_at
string<date-time>
Maximum string length: 64

Response

Announcement updated.

​
id
string
​
updated
boolean