---
title: "Update a celebration entry"
method: PATCH
path: "/v1/celebration-entries/{id}"
tags: ["celebration-entries"]
---

# Update a celebration entry

`PATCH /v1/celebration-entries/{id}`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/celebration-entries/{id}`
- Auth: HTTP bearer

Edit one entry in the celebration roster. Accepts any of the fields used when creating an entry.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `sourceId` string, nullable
  - `photoUrl` string, nullable
  - `occasionType` 'birthday' | 'anniversary' | 'custom': Default `birthday`.
  - `occasionMonth` integer, nullable
  - `occasionDay` integer, nullable
  - `occasionYear` integer, nullable
  - `department` string, nullable
  - `title` string, nullable
  - `location` string, nullable
  - `customMessage` string, nullable
  - `externalId` string, nullable
  - `nodeId` string, nullable

## Response `200`

Success.

- object
  - `data` CelebrationEntry, required: A person's birthday, work anniversary or other occasion for the Celebrations app.
    - `id` string, required
    - `spaceId` string, required
    - `nodeId` string, nullable, required: Home location; null = workspace root. Follows the data source's location when not set.
    - `sourceId` string, nullable, required: The data source it came from, if any.
    - `name` string, required
    - `photoUrl` string, nullable, required
    - `occasionType` 'birthday' | 'anniversary' | 'custom', required
    - `occasionMonth` integer, nullable, required: 1–12.
    - `occasionDay` integer, nullable, required: 1–31.
    - `occasionYear` integer, nullable, required: The start year for an anniversary.
    - `department` string, nullable, required
    - `title` string, nullable, required
    - `location` string, nullable, required
    - `customMessage` string, nullable, required
    - `externalId` string, nullable, required: The id in the source system, for de-duplication.
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `deletedAt` string, nullable, required: ISO-8601 timestamp (UTC).

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: You do not hold `integration.edit` at the destination location.
- `404`: No such entry in this workspace.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)