Card layout fields

This object represents a field in a card layout in Recall. Card layout fields define how deck fields are displayed in a card layout.

Endpoints

POST     /v1/card_layout_fields         # Create a new card layout field
POST     /v1/card_layout_fields/batch   # Create multiple card layout fields
POST     /v1/card_layout_fields/:id     # Update a card layout field
GET      /v1/card_layout_fields         # List all card layout fields
GET      /v1/card_layout_fields/:id     # Get a card layout field
DELETE   /v1/card_layout_fields/:id     # Delete a card layout field

The card layout field object

{
  "id": "layout_field_7h8j9k0l1m2n",
  "object": "card_layout_field",
  "card_layout": "layout_yT9ktMcdzg4e",
  "color": "primary",
  "deck_field": "field_5gvuzRdHW2ac",
  "font_size": "md",
  "font_weight": "bold",
  "is_front": true,
  "next_to_card_layout_field": null,
  "order": 1,
}

Create a card layout field

curl https://api.recall.cards/v1/card_layout_fields \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "card_layout": "layout_yT9ktMcdzg4e",
    "deck_field": "field_5gvuzRdHW2ac",
    "order": 1,
    "is_front": true,
    "color": "primary",
    "font_size": "md",
    "font_weight": "bold"
  }'

Returns

Returns the created card layout field object.

Batch create card layout fields

To create several card layout fields in a single request, you need to provide the card_layout they will belong to.

In some cases, you may want to place an audio field next to a plain_text or rich_content field. To do this, give the plain_text or rich_content field a temporary_id and pass it as the next_to_card_layout_field value in the audio field. Each temporary ID must be unique within the request. It is never stored or returned.

The batch is atomic: if any card layout field is invalid, the entire batch is rejected and no field is created.

curl https://api.recall.cards/v1/card_layout_fields/batch \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "card_layout": "layout_yT9ktMcdzg4e",
    "data": [
      {
        "temporary_id": "reading_line",
        "deck_field": "field_5gvuzRdHW2ac",
        "is_front": true
      },
      {
        "deck_field": "field_uYS9PpONoqTP",
        "is_front": true,
        "next_to_card_layout_field": "reading_line"
      }
    ]
  }'

Returns

{
  "object": "list",
  "data": [
    // Created card layout field objects, in the order they appear in the request
  ],
}

Update a card layout field

curl https://api.recall.cards/v1/card_layout_fields/layout_field_7h8j9k0l1m2n \
  -u YOUR_API_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "font_weight": "bold"
  }'

Returns

Returns the updated card layout field object.

List all card layout fields

curl https://api.recall.cards/v1/card_layout_fields \
  -u YOUR_API_KEY: \
  -d '{
    "card_layout": "layout_yT9ktMcdzg4e"
  }'

Returns

{
  "object": "list",
  "has_more": false,
  "data": [
    // Card layout field objects...
  ],
}

Get a card layout field

curl https://api.recall.cards/v1/card_layout_fields/layout_field_7h8j9k0l1m2n \
  -u YOUR_API_KEY:

There are no parameters for this endpoint.

Returns

Returns the card layout field object.

Delete a card layout field

curl https://api.recall.cards/v1/card_layout_fields/layout_field_7h8j9k0l1m2n \
  -u YOUR_API_KEY: \
  -X DELETE

There are no parameters for this endpoint.

Returns

{
  "id": "layout_field_7h8j9k0l1m2n",
  "object": "card_layout_field",
  "deleted": true
}