API Endpoints for Row Management
Last updated
Was this helpful?
Last updated
Was this helpful?
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.
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.
/v1/{collection}/merge-rows
The collection ID or name
A string field for rowIdentifierLabel
An array of objects for webFonts
An array of objects for rows
An object field for template
curl -L \
--request POST \
--url 'https://api.getbee.io/v1/{collection}/merge-rows' \
--header 'Authorization: Bearer Enter Dev Console API Key as Bearer token' \
--header 'Content-Type: application/json' \
--data '{"rowIdentifierLabel":"guid","webFonts":[{"fontFamily":"'Arvo', 'Courier New', Courier, monospace","name":"Arvo","url":"https://fonts.googleapis.com/css2?family=Arvo:wght@100;200;300;400;500;600;700;800;900"},{"fontFamily":"'Alegreya', 'Trebuchet MS', Helvetica, sans-serif","name":"Alegreya","url":"https://fonts.googleapis.com/css2?family=Alegreya:wght@100;200;300;400;500;600;700;800;900"},{"fontFamily":"'Chivo', Arial, Helvetica, sans-serif","name":"Chivo","url":"https://fonts.googleapis.com/css2?family=Chivo:wght@100;200;300;400;500;600;700;800;900"}],"rows":[{"empty":false,"locked":false,"synced":true,"type":"one-column-empty","uuid":"55bd90ef-1d57-450d-adab-d97727b1db4a","metadata":{"message_type":"email","name":"test","guid":"0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5"},"container":{"style":{"background-color":"transparent","background-image":"none","background-position":"top left","background-repeat":"no-repeat"}},"content":{"computedStyle":{"hideContentOnDesktop":false,"hideContentOnMobile":false,"rowColStackOnMobile":true,"rowReverseColStackOnMobile":false,"verticalAlign":"top"},"style":{"background-color":"transparent","background-image":"none","background-position":"top left","background-repeat":"no-repeat","color":"#000000","width":"600px"}},"columns":[{"grid-columns":12,"uuid":"56119ad2-574d-4122-8dd1-c1152b5f4879","style":{"background-color":"transparent","border-bottom":"0px solid transparent","border-left":"0px solid transparent","border-right":"0px solid transparent","border-top":"0px solid transparent","padding-bottom":"5px","padding-left":"0px","padding-right":"0px","padding-top":"5px"},"modules":[{"locked":false,"type":"mailup-bee-newsletter-modules-paragraph","uuid":"29cd2a3d-fd76-4537-a91b-b8cb9872d8a3","descriptor":{"computedStyle":{"hideContentOnAmp":false,"hideContentOnDesktop":false,"hideContentOnHtml":false,"hideContentOnMobile":false},"style":{"padding-bottom":"10px","padding-left":"10px","padding-right":"10px","padding-top":"10px"},"paragraph":{"html":"<p>Updated paragraph block.</p>","computedStyle":{"linkColor":"#7747FF","paragraphSpacing":"16px"},"style":{"color":"#101112","direction":"ltr","font-family":"'Alegreya', 'Trebuchet MS', Helvetica, sans-serif","font-size":"16px","font-weight":"400","letter-spacing":"0px","line-height":"120%","text-align":"left"}}}},{"locked":false,"type":"mailup-bee-newsletter-modules-paragraph","uuid":"e22bd20c-805e-439a-832c-f7a100dcaaf2","descriptor":{"computedStyle":{"hideContentOnAmp":false,"hideContentOnDesktop":false,"hideContentOnHtml":false,"hideContentOnMobile":false},"style":{"padding-bottom":"10px","padding-left":"10px","padding-right":"10px","padding-top":"10px"},"paragraph":{"html":"<p>I'm a new paragraph block.</p>","computedStyle":{"linkColor":"#7747FF","paragraphSpacing":"16px"},"style":{"color":"#101112","direction":"ltr","font-family":"'Arvo', 'Courier New', Courier, monospace","font-size":"16px","font-weight":"400","letter-spacing":"0px","line-height":"120%","text-align":"left"}}}}]}]}],"template":{"page":{"description":"","title":"","template":{"name":"template-base","type":"basic","version":"2.0.0"},"body":{"type":"mailup-bee-page-properties","webFonts":[{"fontFamily":"'Alegreya', 'Trebuchet MS', Helvetica, sans-serif","name":"Alegreya","url":"https://fonts.googleapis.com/css2?family=Alegreya:wght@100;200;300;400;500;600;700;800;900"}],"container":{"style":{"background-color":"#ffffff"}},"content":{"computedStyle":{"linkColor":"#7747FF","messageBackgroundColor":"transparent","messageWidth":"600px"},"style":{"color":"#000000","font-family":"Arial, Helvetica, sans-serif"}}},"rows":[{"empty":false,"locked":false,"synced":true,"type":"one-column-empty","uuid":"0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5","metadata":{"uuid":"0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5"},"container":{"style":{"background-color":"transparent","background-image":"none","background-position":"top left","background-repeat":"no-repeat"}},"content":{"computedStyle":{"hideContentOnDesktop":false,"hideContentOnMobile":false,"rowColStackOnMobile":true,"rowReverseColStackOnMobile":false,"verticalAlign":"top"},"style":{"background-color":"transparent","background-image":"none","background-position":"top left","background-repeat":"no-repeat","color":"#000000","width":"600px"}},"columns":[{"grid-columns":12,"uuid":"56119ad2-574d-4122-8dd1-c1152b5f4879","style":{"background-color":"transparent","border-bottom":"0px solid transparent","border-left":"0px solid transparent","border-right":"0px solid transparent","border-top":"0px solid transparent","padding-bottom":"5px","padding-left":"0px","padding-right":"0px","padding-top":"5px"},"modules":[{"locked":false,"type":"mailup-bee-newsletter-modules-paragraph","uuid":"29cd2a3d-fd76-4537-a91b-b8cb9872d8a3","descriptor":{"computedStyle":{"hideContentOnAmp":false,"hideContentOnDesktop":false,"hideContentOnHtml":false,"hideContentOnMobile":false},"style":{"padding-bottom":"10px","padding-left":"10px","padding-right":"10px","padding-top":"10px"},"paragraph":{"html":"<p>I'm a new paragraph block.</p>","computedStyle":{"linkColor":"#7747FF","paragraphSpacing":"16px"},"style":{"color":"#101112","direction":"ltr","font-family":"'Alegreya', 'Trebuchet MS', Helvetica, sans-serif","font-size":"16px","font-weight":"400","letter-spacing":"0px","line-height":"120%","text-align":"left"}}}},{"locked":false,"type":"mailup-bee-newsletter-modules-paragraph","uuid":"e22bd20c-805e-439a-832c-f7a100dcaaf2","descriptor":{"computedStyle":{"hideContentOnAmp":false,"hideContentOnDesktop":false,"hideContentOnHtml":false,"hideContentOnMobile":false},"style":{"padding-bottom":"10px","padding-left":"10px","padding-right":"10px","padding-top":"10px"},"paragraph":{"html":"<p>I'm a new paragraph block.</p>","computedStyle":{"linkColor":"#7747FF","paragraphSpacing":"16px"},"style":{"color":"#101112","direction":"ltr","font-family":"'Arvo', 'Courier New', Courier, monospace","font-size":"16px","font-weight":"400","letter-spacing":"0px","line-height":"120%","text-align":"left"}}}}]}]},{"empty":false,"locked":false,"synced":false,"type":"one-column-empty","uuid":"0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5","container":{"style":{"background-color":"transparent","background-image":"none","background-position":"top left","background-repeat":"no-repeat"}},"content":{"computedStyle":{"hideContentOnDesktop":false,"hideContentOnMobile":false,"rowColStackOnMobile":true,"rowReverseColStackOnMobile":false,"verticalAlign":"top"},"style":{"background-color":"transparent","background-image":"none","background-position":"top left","background-repeat":"no-repeat","color":"#000000","width":"600px"}},"columns":[{"grid-columns":12,"uuid":"56119ad2-574d-4122-8dd1-c1152b5f4879","style":{"background-color":"transparent","border-bottom":"0px solid transparent","border-left":"0px solid transparent","border-right":"0px solid transparent","border-top":"0px solid transparent","padding-bottom":"5px","padding-left":"0px","padding-right":"0px","padding-top":"5px"},"modules":[{"locked":false,"type":"mailup-bee-newsletter-modules-paragraph","uuid":"29cd2a3d-fd76-4537-a91b-b8cb9872d8a3","descriptor":{"computedStyle":{"hideContentOnAmp":false,"hideContentOnDesktop":false,"hideContentOnHtml":false,"hideContentOnMobile":false},"style":{"padding-bottom":"10px","padding-left":"10px","padding-right":"10px","padding-top":"10px"},"paragraph":{"html":"<p>I'm a new paragraph block.</p>","computedStyle":{"linkColor":"#7747FF","paragraphSpacing":"16px"},"style":{"color":"#101112","direction":"ltr","font-family":"'Alegreya', 'Trebuchet MS', Helvetica, sans-serif","font-size":"16px","font-weight":"400","letter-spacing":"0px","line-height":"120%","text-align":"left"}}}},{"locked":false,"type":"mailup-bee-newsletter-modules-paragraph","uuid":"e22bd20c-805e-439a-832c-f7a100dcaaf2","descriptor":{"computedStyle":{"hideContentOnAmp":false,"hideContentOnDesktop":false,"hideContentOnHtml":false,"hideContentOnMobile":false},"style":{"padding-bottom":"10px","padding-left":"10px","padding-right":"10px","padding-top":"10px"},"paragraph":{"html":"<p>I'm a new paragraph block.</p>","computedStyle":{"linkColor":"#7747FF","paragraphSpacing":"16px"},"style":{"color":"#101112","direction":"ltr","font-family":"'Arvo', 'Courier New', Courier, monospace","font-size":"16px","font-weight":"400","letter-spacing":"0px","line-height":"120%","text-align":"left"}}}}]}]}]}}}'{
"message": "Success"
}Successful response
Reference an array of metadata objects from a Beefree template in JSON format.
/v1/{collection}/merge/index
The collection ID or name
An object field for source
curl -L \
--request POST \
--url 'https://api.getbee.io/v1/{collection}/merge/index' \
--header 'Authorization: Bearer Enter Dev Console API Key as Bearer token' \
--header 'Content-Type: application/json' \
--data '{"source":{"page":{"description":"BF-ecommerce-template","title":"BF-ecommerce-template","template":{"name":"template-base","type":"basic","version":"2.0.0"},"body":{"type":"mailup-bee-page-properties","webFonts":[{"name":"Montserrat","fontFamily":"'Montserrat', 'Trebuchet MS', 'Lucida Grande', 'Lucida Sans Unicode', 'Lucida Sans', Tahoma, sans-serif","url":"https://fonts.googleapis.com/css?family=Montserrat"}],"container":{"style":{"background-color":"#FFFFFF"}},"content":{"computedStyle":{"linkColor":"#FF819C","messageBackgroundColor":"transparent","messageWidth":"675px"},"style":{"color":"#000000","font-family":"Arial, 'Helvetica Neue', Helvetica, sans-serif"}}},"rows":[{"locked":false,"type":"two-columns-empty","metadata":{"name":"demo3","guid":"test3"},"container":{"style":{"background-color":"#FF819C","background-image":"none","background-position":"top left","background-repeat":"no-repeat"}},"content":{"computedStyle":{"hideContentOnDesktop":false,"hideContentOnMobile":false,"rowColStackOnMobile":true},"style":{"background-color":"transparent","background-image":"none","background-position":"top left","background-repeat":"no-repeat","color":"#333","width":"675px"}},"columns":[{"grid-columns":6,"style":{"background-color":"transparent","border-bottom":"0px solid transparent","border-left":"0px solid transparent","border-right":"0px solid transparent","border-top":"0px solid transparent","padding-bottom":"0px","padding-left":"0px","padding-right":"0px","padding-top":"30px"},"modules":[{"locked":false,"type":"mailup-bee-newsletter-modules-image","descriptor":{"computedStyle":{"class":"center fixedwidth","width":338},"image":{"alt":"Image","href":"https://beefree.io","src":"https://d1oco4z2z1fhwp.cloudfront.net/templates/default/113/logo_1.png"},"style":{"padding-bottom":"0px","padding-left":"15px","padding-right":"15px","padding-top":"5px","width":"100%"}}},{"locked":false,"type":"mailup-bee-newsletter-modules-divider","descriptor":{"computedStyle":{"align":"center","hideContentOnMobile":true},"style":{"padding-bottom":"10px","padding-left":"10px","padding-right":"10px","padding-top":"10px"},"divider":{"style":{"border-top":"0px solid transparent","height":"20px","width":"100%"}}}}]},{"grid-columns":6,"style":{"background-color":"transparent","border-bottom":"0px solid transparent","border-left":"0px solid transparent","border-right":"0px solid transparent","border-top":"0px solid transparent","padding-bottom":"20px","padding-left":"0px","padding-right":"0px","padding-top":"30px"},"modules":[{"locked":false,"type":"mailup-bee-newsletter-modules-divider","descriptor":{"computedStyle":{"align":"center","hideContentOnMobile":true},"style":{"padding-bottom":"0px","padding-left":"0px","padding-right":"0px","padding-top":"0px"},"divider":{"style":{"border-top":"0px solid transparent","height":"32px","width":"100%"}}}},{"locked":false,"type":"mailup-bee-newsletter-modules-text","descriptor":{"computedStyle":{"hideContentOnMobile":true},"style":{"padding-bottom":"15px","padding-left":"10px","padding-right":"10px","padding-top":"0px"},"text":{"html":"<div class=\"txtTinyMce-wrapper\" style=\"font-family: Montserrat, "Trebuchet MS", "Lucida Grande", "Lucida Sans Unicode", "Lucida Sans", Tahoma, sans-serif; font-size: 12px; line-height: 18px;\" data-mce-style=\"font-family: Montserrat, "Trebuchet MS", "Lucida Grande", "Lucida Sans Unicode", "Lucida Sans", Tahoma, sans-serif; font-size: 12px; line-height: 18px;\">\n<div style=\"line-height: 18px; font-size: 12px; text-align: center;\" data-mce-style=\"line-height: 18px; font-size: 12px; text-align: center;\"><span style=\"font-size: 18px; line-height: 27px;\" data-mce-style=\"font-size: 18px; line-height: 27px;\"><strong><span style=\"line-height: 27px; font-size: 18px;\" data-mce-style=\"line-height: 27px; font-size: 18px;\">ANY DEVICE, ANYWHERE, FAST.</span></strong></span></div>\n</div>","computedStyle":{"linkColor":"#FF819C"},"style":{"color":"#FFFFFF","font-family":"'Montserrat', 'Trebuchet MS', 'Lucida Grande', 'Lucida Sans Unicode', 'Lucida Sans', Tahoma, sans-serif","line-height":"150%"}}}}]}]}]}}}'{
"message": "Success"
}Successful response
Retrieve a list of synced rows from a template.
/v1/{collection}/synced-rows
The collection ID or name
A string field for rowIdentifierLabel
An array of objects for webFonts
An object field for template
curl -L \
--request POST \
--url 'https://api.getbee.io/v1/{collection}/synced-rows' \
--header 'Authorization: Bearer Enter Dev Console API Key as Bearer token' \
--header 'Content-Type: application/json' \
--data '{"rowIdentifierLabel":"guid","webFonts":[{"fontFamily":"'Arvo', 'Courier New', Courier, monospace","name":"Arvo","url":"https://fonts.googleapis.com/css2?family=Arvo:wght@100;200;300;400;500;600;700;800;900"},{"fontFamily":"'Alegreya', 'Trebuchet MS', Helvetica, sans-serif","name":"Alegreya","url":"https://fonts.googleapis.com/css2?family=Alegreya:wght@100;200;300;400;500;600;700;800;900"},{"fontFamily":"'Chivo', Arial, Helvetica, sans-serif","name":"Chivo","url":"https://fonts.googleapis.com/css2?family=Chivo:wght@100;200;300;400;500;600;700;800;900"}],"template":{"page":{"description":"","title":"","template":{"name":"template-base","type":"basic","version":"2.0.0"},"body":{"type":"mailup-bee-page-properties","webFonts":[{"fontFamily":"'Alegreya', 'Trebuchet MS', Helvetica, sans-serif","name":"Alegreya","url":"https://fonts.googleapis.com/css2?family=Alegreya:wght@100;200;300;400;500;600;700;800;900"}],"container":{"style":{"background-color":"#ffffff"}},"content":{"computedStyle":{"linkColor":"#7747FF","messageBackgroundColor":"transparent","messageWidth":"600px"},"style":{"color":"#000000","font-family":"Arial, Helvetica, sans-serif"}}},"rows":[{"empty":false,"locked":false,"synced":true,"type":"one-column-empty","uuid":"0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5","metadata":{"guid":"0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5"},"container":{"style":{"background-color":"transparent","background-image":"none","background-position":"top left","background-repeat":"no-repeat"}},"content":{"computedStyle":{"hideContentOnDesktop":false,"hideContentOnMobile":false,"rowColStackOnMobile":true,"rowReverseColStackOnMobile":false,"verticalAlign":"top"},"style":{"background-color":"transparent","background-image":"none","background-position":"top left","background-repeat":"no-repeat","color":"#000000","width":"600px"}},"columns":[{"grid-columns":12,"uuid":"56119ad2-574d-4122-8dd1-c1152b5f4879","style":{"background-color":"transparent","border-bottom":"0px solid transparent","border-left":"0px solid transparent","border-right":"0px solid transparent","border-top":"0px solid transparent","padding-bottom":"5px","padding-left":"0px","padding-right":"0px","padding-top":"5px"},"modules":[{"locked":false,"type":"mailup-bee-newsletter-modules-paragraph","uuid":"29cd2a3d-fd76-4537-a91b-b8cb9872d8a3","descriptor":{"computedStyle":{"hideContentOnAmp":false,"hideContentOnDesktop":false,"hideContentOnHtml":false,"hideContentOnMobile":false},"style":{"padding-bottom":"10px","padding-left":"10px","padding-right":"10px","padding-top":"10px"},"paragraph":{"html":"<p>I'm a new paragraph block.</p>","computedStyle":{"linkColor":"#7747FF","paragraphSpacing":"16px"},"style":{"color":"#101112","direction":"ltr","font-family":"'Alegreya', 'Trebuchet MS', Helvetica, sans-serif","font-size":"16px","font-weight":"400","letter-spacing":"0px","line-height":"120%","text-align":"left"}}}},{"locked":false,"type":"mailup-bee-newsletter-modules-paragraph","uuid":"e22bd20c-805e-439a-832c-f7a100dcaaf2","descriptor":{"computedStyle":{"hideContentOnAmp":false,"hideContentOnDesktop":false,"hideContentOnHtml":false,"hideContentOnMobile":false},"style":{"padding-bottom":"10px","padding-left":"10px","padding-right":"10px","padding-top":"10px"},"paragraph":{"html":"<p>I'm a new paragraph block.</p>","computedStyle":{"linkColor":"#7747FF","paragraphSpacing":"16px"},"style":{"color":"#101112","direction":"ltr","font-family":"'Arvo', 'Courier New', Courier, monospace","font-size":"16px","font-weight":"400","letter-spacing":"0px","line-height":"120%","text-align":"left"}}}}]}]},{"empty":false,"locked":false,"synced":false,"type":"one-column-empty","uuid":"0922fb70-f97e-4ae8-bcfe-0be9fd09a0d5","container":{"style":{"background-color":"transparent","background-image":"none","background-position":"top left","background-repeat":"no-repeat"}},"content":{"computedStyle":{"hideContentOnDesktop":false,"hideContentOnMobile":false,"rowColStackOnMobile":true,"rowReverseColStackOnMobile":false,"verticalAlign":"top"},"style":{"background-color":"transparent","background-image":"none","background-position":"top left","background-repeat":"no-repeat","color":"#000000","width":"600px"}},"columns":[{"grid-columns":12,"uuid":"56119ad2-574d-4122-8dd1-c1152b5f4879","style":{"background-color":"transparent","border-bottom":"0px solid transparent","border-left":"0px solid transparent","border-right":"0px solid transparent","border-top":"0px solid transparent","padding-bottom":"5px","padding-left":"0px","padding-right":"0px","padding-top":"5px"},"modules":[{"locked":false,"type":"mailup-bee-newsletter-modules-paragraph","uuid":"29cd2a3d-fd76-4537-a91b-b8cb9872d8a3","descriptor":{"computedStyle":{"hideContentOnAmp":false,"hideContentOnDesktop":false,"hideContentOnHtml":false,"hideContentOnMobile":false},"style":{"padding-bottom":"10px","padding-left":"10px","padding-right":"10px","padding-top":"10px"},"paragraph":{"html":"<p>I'm a new paragraph block.</p>","computedStyle":{"linkColor":"#7747FF","paragraphSpacing":"16px"},"style":{"color":"#101112","direction":"ltr","font-family":"'Alegreya', 'Trebuchet MS', Helvetica, sans-serif","font-size":"16px","font-weight":"400","letter-spacing":"0px","line-height":"120%","text-align":"left"}}}},{"locked":false,"type":"mailup-bee-newsletter-modules-paragraph","uuid":"e22bd20c-805e-439a-832c-f7a100dcaaf2","descriptor":{"computedStyle":{"hideContentOnAmp":false,"hideContentOnDesktop":false,"hideContentOnHtml":false,"hideContentOnMobile":false},"style":{"padding-bottom":"10px","padding-left":"10px","padding-right":"10px","padding-top":"10px"},"paragraph":{"html":"<p>I'm a new paragraph block.</p>","computedStyle":{"linkColor":"#7747FF","paragraphSpacing":"16px"},"style":{"color":"#101112","direction":"ltr","font-family":"'Arvo', 'Courier New', Courier, monospace","font-size":"16px","font-weight":"400","letter-spacing":"0px","line-height":"120%","text-align":"left"}}}}]}]}]}}}'{
"message": "Success"
}Successful response