Skip to main content
PUT
Update a favorite

Authorizations

X-API-Key
string
header
required

API key (sk_xxx) from Developer Settings. No X-Account-ID needed.

Headers

x-account-id
string | null

Path Parameters

favorite_id
string<uuid>
required

Body

application/json

Schema for updating an existing favorite.

folder_id
string<uuid> | null
display_order
integer | null
notes
string | null
entity_name
string | null

Custom name for the favorite

Maximum string length: 255

Response

Successful Response

Response schema for favorite API endpoints.

entity_type
string
required

Entity type: 'company', 'contact', or 'deal'

entity_id
string<uuid>
required

ID of the favorited entity

id
string<uuid>
required
account_id
string<uuid>
required
user_id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
folder_id
string<uuid> | null

Folder ID to organize favorites

display_order
integer | null

Display order

notes
string | null

Optional notes about why it's favorited

entity_name
string | null

Name of the favorited entity