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.
Row-Related API endpoints
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.
Row Endpoints and Descriptions
Merge Rows
Endpoint: POST https://api.beefree.io/v1/{collection}/merge-rows
Merge Rows
post
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.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
collectionstringRequired
The collection ID or name
Body
rowIdentifierLabelstringOptional
A string field for rowIdentifierLabel
Responses
200
Successful response
application/json
Responseobject
400
Bad request
401
Unauthorized
403
Forbidden
500
Internal Server Error
post
/v1/{collection}/merge-rows
Index Rows
Endpoint: POST https://api.beefree.io/v1/{collection}/merge/index
Index
post
Reference an array of metadata objects from a Beefree template in JSON format.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
collectionstringRequired
The collection ID or name
Body
Responses
200
Successful response
application/json
Responseobject
400
Bad request
401
Unauthorized
403
Forbidden
500
Internal Server Error
post
/v1/{collection}/merge/index
Retrieve Synced Rows
Endpoint: POST https://api.beefree.io/v1/{collection}/synced-rows
Synced Rows
post
Retrieve a list of synced rows from a template.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
collectionstringRequired
The collection ID or name
Body
rowIdentifierLabelstringOptional
A string field for rowIdentifierLabel
Responses
200
Successful response
application/json
Responseobject
400
Bad request
401
Unauthorized
403
Forbidden
500
Internal Server Error
post
/v1/{collection}/synced-rows
Workflow Example
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.
