# Create or update an announcement

`PUT /v1/admin/site/announcements`

URL: https://docs.spacerun.co/docs/platform/reference/announcements/upsertSiteAnnouncement

- **Operation ID:** `upsertSiteAnnouncement`
- **Tags:** Announcements
- **Base URL:** `http://localhost:8787`

Creates (no `id`) or updates an announcement. Saving with status `published` invalidates the site-config cache. Emits a dashboard event; audited.

**Workflow:** [Integration guide](https://docs.spacerun.co/docs/platform/guides/site-publishing).

**Authentication:** staff Bearer JWT with permission `announcements.write`.

## Authentication

- **Auth:** staff Bearer JWT (`Authorization: Bearer <access_token>`) with the permissions below.
- **Required permissions:** `announcements.write`

## Request body

Required: yes.

Content type: `application/json`

Schema: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string<uuid> \| null` | no | - |
| `kind` | `string` | no | One of: `"banner"`, `"modal"`. Default: `"banner"` |
| `surfaces` | `string[]` | no | Default: `["portal"]`. Min items: 1 |
| `severity` | `string` | no | One of: `"info"`, `"success"`, `"warning"`, `"critical"`. Default: `"info"` |
| `title` | `string` | yes | Min length: 1. Max length: 200 |
| `bodyMd` | `string \| null` | no | - |
| `ctaLabel` | `string \| null` | no | - |
| `ctaUrl` | `string<uri> \| null` | no | - |
| `audience` | `object` | no | Default: `{}` |
| `audience.user_ids` | `string<uuid>[]` | no | - |
| `audience.roles` | `string[]` | no | - |
| `dismissible` | `boolean` | no | Default: `true` |
| `status` | `string` | no | One of: `"draft"`, `"published"`, `"archived"`. Default: `"draft"` |
| `startsAt` | `string<date-time>` | no | - |
| `endsAt` | `string<date-time> \| null` | no | - |

## Responses

### 200

Announcement id.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (SiteIdResult)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string<uuid>` | yes | - |

## Errors

### 400

Request validation failed.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ValidationErrorBody)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | `boolean` | yes | One of: `false` |
| `error` | `object` | yes | - |
| `error.name` | `string` | yes | One of: `"ZodError"` |
| `error.issues` | `object[]` | yes | - |
| `error.issues[].code` | `string` | yes | - |
| `error.issues[].path` | `(string \| number)[]` | yes | - |
| `error.issues[].message` | `string` | yes | - |

**Request validation**

```json
{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}
```

### 401

Missing, malformed, expired or wrong-audience Bearer token (`missing_token`, `invalid_token`, `invalid_audience`).

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `error` | `string` | yes | Stable machine-readable error code, e.g. `forbidden`, `not_found`. |
| `details` | `any` | no | Optional structured context. For 403 it is `{ perm }`. |

**Error response**

```json
{
  "error": "missing_token"
}
```

### 403

Authenticated but lacking the required permission. `details.perm` lists the accepted permission keys.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "forbidden",
  "details": {
    "perm": "announcements.write"
  }
}
```

### 404

`not_found`: announcement id does not exist.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "not_found"
}
```

### 500

Unexpected server error (`internal`). No details are returned.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "internal"
}
```

## Examples

### curl

```bash
curl -X PUT 'http://localhost:8787/v1/admin/site/announcements' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"id":"3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90","kind":"banner","surfaces":["portal"],"severity":"info","title":"example","bodyMd":"example","ctaLabel":"example","ctaUrl":"https://example.com/resource","audience":{},"dismissible":true,"status":"draft","startsAt":"2026-01-15T12:00:00.000Z","endsAt":"2026-01-15T12:00:00.000Z"}'
```

### TypeScript

```ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/site/announcements", {
  method: "PUT",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90",
    "kind": "banner",
    "surfaces": [
      "portal"
    ],
    "severity": "info",
    "title": "example",
    "bodyMd": "example",
    "ctaLabel": "example",
    "ctaUrl": "https://example.com/resource",
    "audience": {},
    "dismissible": true,
    "status": "draft",
    "startsAt": "2026-01-15T12:00:00.000Z",
    "endsAt": "2026-01-15T12:00:00.000Z"
  }),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();
```