Celebration entries API

GET/v1/celebration-entries

Return the roster of birthdays, anniversaries, and other occasions that the Celebrations app displays. **Notes.** - Only entries at locations the caller can see.

curl "https://api.brixsignage.com/v1/celebration-entries" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/celebration-entries

Add an entry to the celebration roster. Requires name; also accepts occasionType, occasionMonth, occasionDay, occasionYear, photoUrl, department, title, location, customMessage, sourceId, and externalId, all optional. **Notes.** - The 201 body is the row as written, not re-read from the database, so columns the create does not set (for example lastSnapshotAt) are absent rather than null. GET returns every column.

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/celebration-entries" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Sam Rivera","occasionType":"birthday","occasionMonth":10,"occasionDay":4,"department":"Kitchen"}'

Response 201 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 You do not hold `integration.create` at the location.

Response 422 `name` is missing, or a location or data source outside this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

GET/v1/celebration-entries/{id}

Return one entry from the celebration roster.

curl "https://api.brixsignage.com/v1/celebration-entries/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such entry in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

PATCH/v1/celebration-entries/{id}

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

Request body application/json

curl -X PATCH "https://api.brixsignage.com/v1/celebration-entries/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 You do not hold `integration.edit` at the destination location.

Response 404 No such entry in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

DELETE/v1/celebration-entries/{id}

Remove an entry from the celebration roster. The entry moves to the recycle bin and can be brought back with the restore operation.

curl -X DELETE "https://api.brixsignage.com/v1/celebration-entries/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such entry in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/celebration-entries/{id}/restore

Bring back a deleted celebration entry so it appears again in the celebration app's roster.

curl -X POST "https://api.brixsignage.com/v1/celebration-entries/{id}/restore" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such entry in this workspace, or it was purged.

Response 409 `not_deleted`: the entry is not in the recycle bin.

Response 5XX Server error. The body carries a `requestId` to quote to support.