Journey Docs
Members APICollections

Create Collection

Create a new collection for organizing favorites

POST/members/me/collections

Overview

Creates a new collection for the authenticated member. Collections allow members to organize their favorited properties into groups like "Honeymoon Destinations", "Business Travel", or "Weekend Getaways".

Authentication

Requires a valid Clerk JWT token in the Authorization header.

Request Body

namebodystringrequired

Collection name (max 255 characters)

notesbodystring

Optional notes or description for the collection

Request

curl -X POST "http://localhost:3000/v1/members/me/collections" \
  -H "Authorization: Bearer YOUR_CLERK_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Honeymoon Destinations",
    "notes": "Romantic properties for our upcoming honeymoon trip"
  }'

Response

idnumberrequired

Unique collection ID

externalIdstringrequired

External identifier for the collection

namestringrequired

Display name of the collection

notesstring

Optional notes or description for the collection

isSystembooleanrequired

Whether this is a system-managed collection (always false for user-created)

itemCountnumberrequired

Number of properties in this collection (starts at 0)

itemsarrayrequired

Properties in the collection (empty for new collections)

createdAtstringrequired

ISO 8601 timestamp when collection was created

updatedAtstringrequired

ISO 8601 timestamp when collection was last updated

Response

{
  "id": 5,
  "externalId": "coll_789xyz",
  "name": "Honeymoon Destinations",
  "notes": "Romantic properties for our upcoming honeymoon trip",
  "isSystem": false,
  "itemCount": 0,
  "items": [],
  "createdAt": "2024-04-20T15:30:00Z",
  "updatedAt": "2024-04-20T15:30:00Z"
}

Collection Naming

Requirements

  • Length: Must be 255 characters or less
  • Required: Name cannot be empty
  • Uniqueness: Names don't need to be unique per member

Best Practices

  • Descriptive: Use clear, descriptive names
  • Organized: Consider themes like "Business Travel", "Family Vacations"
  • Personal: Make them meaningful to your travel planning

Collection Limits

While there's no hard limit on the number of collections a member can create, consider:

  • Practical Limits: Too many collections can become difficult to manage
  • Performance: Very large numbers may impact load times
  • User Experience: Focus on meaningful organization

Next Steps

After creating a collection, you can:

  1. Add Favorites: Use Add Favorite to add properties

On this page