Post apiv1projects announcements - Lightdash

Error

A valid request URL is required to generate request examples

{
  "results": {
    "updatedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "authorName": "<string>",
    "createdByUserUuid": "<string>",
    "scheduledPublishAt": "2023-11-07T05:31:56Z",
    "pendingSlackChannelId": "<string>",
    "published": true,
    "pinned": true,
    "category": "launch",
    "body": "<string>",
    "title": "<string>",
    "projectUuid": "<string>",
    "announcementUuid": "<string>"
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

POST

/

api

/

v1

/

projects

/

{projectUuid}

/

announcements

Error

A valid request URL is required to generate request examples

{
  "results": {
    "updatedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "authorName": "<string>",
    "createdByUserUuid": "<string>",
    "scheduledPublishAt": "2023-11-07T05:31:56Z",
    "pendingSlackChannelId": "<string>",
    "published": true,
    "pinned": true,
    "category": "launch",
    "body": "<string>",
    "title": "<string>",
    "projectUuid": "<string>",
    "announcementUuid": "<string>"
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Path Parameters

projectUuid

string<uuid>

required

Stringified UUIDv4. See RFC 4112

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Body

application/json

category

enum<string> | null

required

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.

Available options:

launch,

update,

heads_up

body

string | null

required

title

string

required

scheduledPublishAt

string<date-time>

Future UTC instant at which the announcement publishes automatically (Slack notification fires then). Mutually exclusive with publishNow.

publishNow

boolean

When true the announcement goes live immediately and its Slack notification (if any) fires now, instead of waiting for the next homepage publish. Used when posting from the published homepage. Mutually exclusive with scheduledPublishAt.

slackChannelId

string | null

Transient (not persisted): when set, publishing posts a notification to this Slack channel. Requires the org to have Slack installed.

Response

Created

results

object

required

Show child attributes

status

enum<string>

required

Available options:

ok