Last updated
© Bee Content Design, Inc. San Francisco, CA | Part of Growens
Last updated
Beefree SDK provides robust APIs for managing rows. These API endpoints enable operations such as saving, retrieving, syncing, merging, and organizing rows, making them essential for maintaining design consistency and managing shared rows.
Merge Rows API endpoints
Purpose: Updates linked rows across multiple designs by replacing outdated content with new versions. Ideal for batch-updating designs or maintaining consistent synced rows.
Synced Rows API endpoint
Purpose: Retrieves all rows marked as "synced," ensuring centralized tracking of synced rows across templates.
Index Rows API endpoint
Purpose: Generates metadata for template rows, enabling better organization and search capabilities. Create structured catalogs of rows with attributes like categories, names, or tags.
Merge Rows
Endpoint: POST https://api.beefree.io/v1/{collection}/merge-rows
Index Rows
Endpoint: POST https://api.beefree.io/v1/{collection}/merge/index
Retrieve Synced Rows
Endpoint: POST https://api.beefree.io/v1/{collection}/synced-rows
Retrieve Synced Rows: Use the Synced Rows endpoint to identify synced rows across designs.
Modify a Synced Row: Update the row and submit changes using the Merge Rows endpoint.
Verify Updates: Confirm that updates are reflected in all linked templates based on the Merge Rows response.
Reference an array of metadata objects from a Beefree template in JSON format.
The collection ID or name
JSON payload containing the Beefree template
A Beefree template in JSON format
An array of metadata objects containing row details
The Merge Rows endpoint enables you to integrate custom fonts and resized images into your designs. It saves custom fonts within the template's JSON, ensuring the correct font is displayed. It also handles image resizing, particularly when the image's initial template width is narrower than the saved row's destination template. To use this endpoint, send your template and rows in JSON format. You will receive a response with an updated template. The rows requiring an update are identified by their rowIdentifier values.
The collection ID or name
JSON payload with the template and rows
Label for identifying rows, usually GUID
An array of Beefree rows in JSON format
A Beefree template in JSON format
List of available webfonts to rectify missing ones
Updated template with merged rows
Retrieve a list of synced rows from a template.
The collection name.
Parameters for the synced rows request.
The label used for identifying the rows added to the metadata key, usually GUID.
The JSON structure of the template.
A successful response with a list of synced rows.