celebration-entries

Create a celebration entry

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.
post/v1/celebration-entries

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/celebration-entries
  • Auth: HTTP bearer

Request body

namestring required
sourceIdstring nullable
photoUrlstring nullable
occasionType'birthday' | 'anniversary' | 'custom'

Default birthday.

occasionMonthinteger nullable
occasionDayinteger nullable
occasionYearinteger nullable
departmentstring nullable
titlestring nullable
locationstring nullable
customMessagestring nullable
externalIdstring nullable
nodeIdstring nullable

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.