Account

Add a favorite

Adds a firearm to your favorites. Idempotent: adding twice is not an error.

Requires an API key belonging to a user account. Acts on the calling account's own data.

post/v1/me/favorites/{firearmId}

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/me/favorites/{firearmId}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

firearmIdstring required

Firearm slug

Response

Add a favorite

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": {
    "favorited": true,
    "firearmId": "glock-g17-gen5"
  }
}

Changes

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