celebration-entries

Update a celebration entry

Edit one entry in the celebration roster. Accepts any of the fields used when creating an 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

Path parameters

idstring required

Celebration entry id.

Request body

namestring
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.