Favorites

Add favorite

Requires Authorization.

POST /v3/me/favorites/{profileId}

Response:

Empty object ({}).

Remove favorite

Requires Authorization.

DELETE /v3/me/favorites/{profileId}

Response:

Empty object ({}).

Get all notes

Requires Authorization.

GET /v1/favorites/notes

Response:

Array of FavoriteNoteWithCounterparty.

Replace notes list

Requires Authorization.

PUT /v1/favorites/notes

Body:

• notes — array of FavoriteNoteRequest

Get note

Requires Authorization.

GET /v1/favorites/notes/{targetProfileId}

Response:

FavoriteNoteWithCounterparty

Add note

Requires Authorization.

The counterpartyId parameter seems to be ignored; it's unknown what its purpose is.

PUT /v1/favorites/notes/{targetProfileId}

Body:

• counterpartyId — long integer, profile ID or null
• notes — string or null
• phoneNumber — string or null

Response:

Empty, HTTP status 204.

Delete note

Requires Authorization.

Essentially equivalent to Add note with notes set to "".

DELETE /v1/favorites/notes/{targetProfileId}

FavoriteNote

• notes — string, empty for nonexistent notes
• phoneNumber — string, might be empty

FavoriteNoteWithCounterparty

• everything from FavoriteNote
• counterpartyId — long integer, profile ID

FavoriteNoteRequest

• counterpartyId — long integer, profile ID or null, optional
• notes — string or null, optional
• phoneNumber — string or null, optional