PATCH
/
{version}
/
announcements
/
{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": {
    "id": 123,
    "title": "<string>",
    "content": "<string>",
    "color": "<string>",
    "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
​
content
string
required

Supports HTML.

​
color
string
required

Provided as a 6 digit hex code.

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

Response

200
application/json
OK
​
data
object

Was this page helpful?

Delete announcementCreate a batch of announcements