Homepage

PATCH /api/v1/projects/{projectUuid}/announcements/{announcementUuid}

Request

Base URL
/ (relative, and the document’s source URL is not known)
Auth
none required
TypeScript
https://skmtc.dev/lightdash/apis/lightdash-api/docs/api/v1/projects/:projectUuid/announcements/:announcementUuid/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectUuidstring uuid required

Stringified UUIDv4. See RFC 4112

announcementUuidstring uuid required

Stringified UUIDv4. See RFC 4112

Request body

slackChannelIdstring nullable

Only drafts: set to retarget the Slack notification, null to cancel it

pinnedboolean

category'launch' | 'update' | 'heads_up'

Curated announcement categories a data team uses to signal intent to business users. Fixed set (not user-managed) — each maps to a label + colour in ANNOUNCEMENT_CATEGORY_META.

bodystring nullable

titlestring

Response

Success

status'ok' required

Changes

No recorded changes to this operation across all 1 revision of this API.