CRcrisiscleanup
System

Manage favorites

Favorite or unfavorite a particular entity

post/worksites/{id}/favorite

Request

Request body

idinteger
favorite_idinteger
type_tstring nullable

A translated string indicating the type of favorite relationship. For example, pin describes the special type of favorite between an incident and a file, where the file is pinned in a conspicuous location within the incident; or to an organization and a message, where the message is pinned or promoted. member_of_organization describes the special type of favorite between an organization and a worksite, where the resident at the worksite is a member of that organization. Where there is no specialized type of favorite, then this value is simply favorite, for example, to identify a favorite report, another favorite user, or a favorite affiliate.

created_atstring date-time

Timestamp when the favorite was created.

Response

Entity favorited (POST)

Changes

No recorded changes to this operation across all 3 revisions of this API.