Skip to main content
POST
Create an announcement

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).

Body

application/json
targets
object
required

Audience targeting object - required, validated server-side.

title
string
Maximum string length: 500
summary
string
Maximum string length: 2000
content
string
Maximum string length: 50000
icon
string
Maximum string length: 256
Maximum string length: 2048
status
enum<string>
Available options:
draft,
active,
archived
Maximum string length: 32
expires_at
string<date-time>
Maximum string length: 64

Response

Announcement created.

id
string
orgSlug
string | null
title
string
summary
string
targets
object

Audience targeting object - validated and normalized server-side by internal/validate-announcement-targets. Common shape exposes roles, permissions, products, userIds.

status
enum<string>
Available options:
draft,
active,
archived
expires_at
string
createdAt
string<date-time>