Add Favorite

OverviewCopy Anchor Link

Adds a property to the member's favorites. The property can be added to a specific collection or the default favorites collection if no collection is specified.

AuthenticationCopy Anchor Link

Requires a valid Clerk JWT token in the Authorization header.

Request BodyCopy Anchor Link

curl -X POST "http://localhost:3000/v1/members/me/collections/favorites" \
  -H "Authorization: Bearer YOUR_CLERK_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "propertyDocumentId": "prop_luxury_maldives"
  }'

ResponseCopy Anchor Link

{
  "propertyDocumentId": "prop_luxury_maldives",
  "propertyName": "Luxury Resort Maldives",
  "propertySlug": "luxury-resort-maldives",
  "heroImageUrl": "https://cdn.journey.com/properties/maldives-hero.jpg",
  "collectionId": 1,
  "addedAt": "2024-04-20T16:45:00Z"
}

Collection AssignmentCopy Anchor Link

Default CollectionCopy Anchor Link

• No collectionId: Property goes to default "Favorites" collection
• collectionId: null: Explicitly add to default collection
• Auto-created: Default collection exists for every member

Specific CollectionCopy Anchor Link

• collectionId: number: Property goes to the specified collection
• Must exist: Collection must belong to the member
• Validation: System checks collection ownership

Duplicate HandlingCopy Anchor Link

Already FavoritedCopy Anchor Link

• Same Collection: Returns 409 error if property already in that collection
• Different Collection: Property can exist in multiple collections (if supported)
• Default vs Named: Same property can be in default and named collections

Error PreventionCopy Anchor Link

• Check favorite status before adding
• Handle 409 errors gracefully in your UI
• Consider showing "already favorited" state to users

Property ValidationCopy Anchor Link

Valid PropertiesCopy Anchor Link

• Exists: Property must exist in the system
• Active: Property should be bookable/visible
• Document ID: Must use the property's document ID, not internal ID

Invalid PropertiesCopy Anchor Link

• Not Found: Returns 404 for non-existent properties
• Invalid Format: Returns 400 for malformed document IDs
• Restricted: Some properties may not be favoritable

Related EndpointsCopy Anchor Link

• Get Favorites - View all favorites
• Remove Favorite - Remove from favorites
• Check Favorite Status - Check if already favorited
• Get Collections - View available collections