Skip to main content
POST
/
announcements
Create Announcement
curl --request POST \
  --url https://api.roostedhr.com/api/1_12/announcements \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "subject": "<string>",
  "message": "<string>",
  "output": 2,
  "all": 0,
  "replies": [
    123
  ],
  "skillsets": "<string>",
  "selected_workers": [
    123
  ]
}
'
{
  "error": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Announcement Request Body

​
subject
string
required
​
message
string
required
Required string length: 1 - 1000
​
output
integer
required

1 - Send only via email 2 - Send only via text message 3 - Send via both text message and email

Required range: 1 <= x <= 3
​
all
integer
required

0 - Do not send to everyone 1 - Send to everyone

Required range: 0 <= x <= 1
​
replies
integer[]
required

Array of admin IDs to whom the replies will be sent

​
skillsets
string

Skillset ID of workers to who the announcement will be sent

​
selected_workers
integer[]

Response

Created