---
title: "Edit an announcement"
method: PATCH
path: "/announcements/{id}"
tags: ["Announcements"]
---

# Edit an announcement

`PATCH /announcements/{id}`

## Request

- Base URL: `https://developer.solofire.com/v1`
- URL: `https://developer.solofire.com/v1/announcements/{id}`
- Auth: HTTP bearer

Requires the `announcements.write` scope.

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `title` string: Announcement title.
  - `body` string: Body as plain text with light Markdown (headings, bullets, bold, italic, links). Either body or body_delta.
  - `body_delta` unknown[]: Body as a Quill Delta ops array, stored verbatim. Either body or body_delta.
    - unknown
  - `configuration_ids` unknown[]: Configurations whose users see it. Required and non-empty on create.
    - unknown
  - `file_ids` unknown[]: Attached library files. Only allowed when exactly one configuration is targeted.
    - unknown
  - `notify` boolean: Create only: send push and email notifications. Defaults to true.

## Response `200`

Success

- object

## Other responses

- `401`: `unauthorized` No credential was presented. `invalid_token` The API key is unknown, revoked or malformed. `token_expired` The API key has passed its expiry.
- `403`: `insufficient_scope` The credential does not carry the required scope. `forbidden` The member this credential acts as lacks the permission. `feature_not_enabled` API access is not enabled for this company.
- `404`: `not_found` No such resource, or it is outside this credential’s scope.
- `405`: `method_not_allowed` The path exists but not for this method.
- `413`: `payload_too_large` The request body is too large.
- `422`: `validation_failed` A parameter or body field is invalid.
- `429`: `rate_limited` The credential is over its request budget.
- `500`: `internal_error` Something went wrong on our side.

---

[API](https://skmtc.dev/solofire/apis/solofire-api.md) · [All operations](https://skmtc.dev/solofire/apis/solofire-api/llms.txt) · [OpenAPI document](https://skmtc.dev/solofire/apis/solofire-api/revisions/23e387532175?raw)