Carbon

Quote Favorite

The quote favorite resource.

Basehttps://rest.carbon.ms/quoteFavorite
GET/quoteFavorite

List quote favorites

Retrieve a paginated list of quote favorites. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/quoteFavorite
curl --request GET \
  --url 'https://rest.carbon.ms/quoteFavorite?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "quoteId": "xyz789",
    "userId": "xyz789"
  }
]
GET/quoteFavorite

Retrieve a quote favorite

Fetch a single quote favorite by filtering on `quoteId`.

Query parameters

quoteIdstring

Match on the quote favorite's `quoteId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/quoteFavorite
curl --request GET \
  --url 'https://rest.carbon.ms/quoteFavorite?quoteId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "quoteId": "xyz789",
  "userId": "xyz789"
}
POST/quoteFavorite

Create a quote favorite

Create a new quote favorite.

POSThttps://rest.carbon.ms/quoteFavorite
curl --request POST \
  --url https://rest.carbon.ms/quoteFavorite \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"quoteId":"xyz789"}'
Response
{
  "quoteId": "xyz789",
  "userId": "xyz789"
}
PATCH/quoteFavorite

Update a quote favorite

Update an existing quote favorite, matched on `quoteId`.

PATCHhttps://rest.carbon.ms/quoteFavorite
curl --request PATCH \
  --url 'https://rest.carbon.ms/quoteFavorite?quoteId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "quoteId": "xyz789",
  "userId": "xyz789"
}
DELETE/quoteFavorite

Delete a quote favorite

Delete a quote favorite, matched on `quoteId`. Returns 204 No Content.

Query parameters

quoteIdstring

The `quoteId` of the quote favorite to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/quoteFavorite
curl --request DELETE \
  --url 'https://rest.carbon.ms/quoteFavorite?quoteId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content