PATCH
/
{version}
/
announcements
/
{announcement}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
version
enum<string>
default:
v2
required

The API version to use.

Available options:
v1,
v2
​
announcement
integer
required

Body

application/json
​
color
string
required

Provided as a 6 digit hex code.

​
content
string
required

Supports HTML.

​
title
string
required
​
enabled
boolean
default:
true
​
expires_at
string | null
​
global
boolean
default:
false

Response

200 - application/json
​
data
object

Was this page helpful?

Delete announcementCreate a batch of announcements