Site

Publish or update the site-wide notice

Changed on

Admin only. Upserts the single site notice. Set active: false to hide it.

put/site-notice

Request

  • Base URL: https://api.releases.sh
  • URL: https://api.releases.sh/site-notice
  • Auth: HTTP bearer

Request body

activeboolean required
messagestring required
linkTextstring
hrefstring
placement'home' | 'banner' required
colorstring required
dismissibleboolean required

Response

The stored notice

Changes

  • 2abc1553baf2Revision changes
    • info

      the // response's property pattern was changed from ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ to ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ for the status

  • ef21361a36e6Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status