🗒️Announcement

Pin announcements to your URL whiteboards.

Get Announcements

This will get the whole list of announcements related to your domain.

interface AnnouncementItem {
  url_setting_id: string;
  text: string;
}


const announcements : AnnouncementItem[] = await proticoAPI.announcement.get(domain:string);

Parameters description

Parameter	Description	Type
domain	Current domain	string

Get One Announcement

To get a single announcement by ID.

const announcement : AnnouncementItem = await proticoAPI.announcement.getOne(urlSettingId:string);

Parameters description

Parameter	Description	Type
urlSettingId	ID of the setting corresponding to that whiteboard. See Settings	string

Add One Announcement

To get information about a particular address in the blocklist

const announcement : AnnouncementItem = await proticoAPI.announcement.addOne(domain:string,data:AnnouncementItem);

Parameters description

Parameter	Description	Type
domain	Current domain	string
data.url_setting_id	ID of the setting corresponding to that whiteboard. See Settings	string
data.text	Announcement text	string

Delete One Announcement

Remove an announcement.

const announcement : AnnouncementItem = await proticoAPI.announcement.deleteOne(urlSettingId:string);

Parameters description

Parameter	Description	Type
urlSettingId	ID of the setting corresponding to that whiteboard. See Settings	string

Update One Announcement

To update an announcement

const blocklist : BlocklistItem = await proticoAPI.blocklist.updateOne(domain:string,address:string,data:Partial<BlocklistItem>);

Parameters description

Parameter	Description	Type
urlSettingId	ID of the setting corresponding to that whiteboard. See Settings	string
data	Announcement, such as shown above in Add One Announcement	AnnouncementItem