POST restapi/personal/messages/{messageId}/toggleFavorite/v1?isFavorite={isFavorite}&messageOrigin={messageOrigin}

Toggles a message's IsFavorite property.

Only supports toggling the current favorite value of the message. Will return HTTP status 401 if user does not have access.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
messageId

The message Id

integer

Required

isFavorite

Optional query param used for KPI logic in MessageDropDown section

boolean

None.

messageOrigin

Optional query param. The origin of this api call in the UI.

Itsolutions.ItslUtils.Constants.MessageOrigin

None.

Body Parameters

None.

Response Information

Resource Description

200 if the user is authenticated

System.Net.Http.HttpResponseMessage
NameDescriptionTypeAdditional information
Version

System.Version

None.

Content

System.Net.Http.HttpContent

None.

StatusCode

System.Net.HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

System.Net.Http.HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.