Announcements

Notices to members.

4 endpoints · base URL https://api.aerscheduler.com

get/announcements

List announcements

Live notices for your organization. Expired ones are swept hourly.

Responses

`200`	OK	The announcements.→ { data: Announcement[] }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl https://api.aerscheduler.com/announcements \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

post/announcements

Post an announcement

Notifies the roles you target. Requires the admin role.

Request body

The notice.

`title`required	`string`
`message`required	`string`
`expireAt`	`string`
`forRoles`	`string[]`

Responses

`200`	OK	Success.→ { data: Announcement }
`201`	Created	Success.→ { data: Announcement }
`400`	Bad Request	Validation failed.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X POST https://api.aerscheduler.com/announcements \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"…","message":"…"}'

patch/announcements/{id}

Update an announcement

Requires the admin role.

Path parameters

idrequired integer The announcement id.

Request body

Fields to change.

`title`	`string`
`message`	`string`
`expireAt`	`string`

Responses

`200`	OK	Success.→ { data: Announcement }
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X PATCH https://api.aerscheduler.com/announcements/:id \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"…","message":"…"}'

delete/announcements/{id}

Delete an announcement

Requires the admin role.

Path parameters

idrequired integer The announcement id.

Responses

`204`	No Content	Success. No body.
`401`	Unauthorized	No token, an expired token, or a malformed one. Sign in again.
`403`	Forbidden	Authenticated, but not allowed to do this.
`429`	Too Many Requests	Rate limited. `Retry-After` says how long to wait.

Example request

curl -X DELETE https://api.aerscheduler.com/announcements/:id \
  -H "Authorization: Bearer $AERSCHEDULER_TOKEN"

PreviousDocumentsFiles held against members.NextNotificationsPer-member in-app notifications.