contacts

Favorite / unfavorite a contact

An owner may keep MANY favorites. Any non-null rank FAVORITES the contact (appended to the end of the favorites list — it never unfavorites another contact; already-favorited is a no-op); rank=null UNFAVORITES it. favorite_rank is a per-owner ordering, not a single slot, and favorites float to the top of the contacts list.

post/contacts/{id}/favorite

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/contacts/{id}/favorite
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Path parameters

idstring required

id

Request body

rankinteger

Response

OK

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.