Skip to main content
PATCH
/
{version}
/
announcements
/
{announcement}
Update announcement
curl --request PATCH \
  --url https://api.perscom.io/{version}/announcements/{announcement} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "content": "<string>",
  "color": "<string>",
  "global": false,
  "enabled": true,
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "data": {
    "title": "<string>",
    "content": "<string>",
    "color": "<string>",
    "id": 123,
    "global": false,
    "enabled": true,
    "expires_at": "2023-11-07T05:31:56Z",
    "label": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

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
​
title
string
required

The announcement title.

Maximum string length: 255
​
content
string
required

The announcement content. Supports HTML.

Maximum string length: 65535
​
color
string
required

The announcement color. Provided as a 6 digit hex code.

Maximum string length: 255
​
global
boolean
default:false

Whether the announcement is displayed globally to all users.

​
enabled
boolean
default:true

Whether the announcement is enabled and visible to users.

​
expires_at
string<date-time> | null

The date and time when the announcement expires. Stored in UTC.

Response

OK

​
data
AnnouncementResource · object