Available Methods
list
List announcements
GET /api/v1/announcements
Signature: lb.announcements.list({ query?: \{ page, size, priority, tag, active, sort_by, sort_dir \} })
Parameters:
Returns:
create
Create an announcement
POST /api/v1/announcements
Signature: lb.announcements.create({ body: \{ ... \} })
Parameters:
Returns:
delete
Delete an announcement
DELETE /api/v1/announcements/{id}
Signature: lb.announcements.delete({ path: \{ id \} })
Parameters:
get
Get an announcement
GET /api/v1/announcements/{id}
Signature: lb.announcements.get({ path: \{ id \} })
Parameters:
Returns:
patch
Partially update an announcement
PATCH /api/v1/announcements/{id}
Signature: lb.announcements.patch({ path: \{ id \}, body: \{ ... \} })
Parameters:
Returns:
uploadCover
Upload announcement cover image (multipart/form-data, field: file)
PUT /api/v1/announcements/{id}/cover
Signature: lb.announcements.uploadCover({ path: \{ id \}, body: \{ ... \} })
Parameters:
Returns:
publish
Publish an announcement (queues email delivery)
POST /api/v1/announcements/{id}/publish
Signature: lb.announcements.publish({ path: \{ id \}, body: \{ ... \} })
Parameters:
Returns: