Try it outMCP ServerBook a demoCookbook

Row Processing

This page lists and describes the Row Processing category of endpoints within the Content Services API. It also includes interactive testing environments for each endpoint in this category.

Row Processing endpoints are part of the Content Services API. The Content Services API is available on Beefree SDK plans that are Essentials or above.

Overview

The Rows endpoints help you keep templates consistent and avoid redundancy. Use them to list saved rows, apply updates across multiple templates, or retrieve synced rows.

Available Collection Values for Row Processing Endpoints

The following table lists the collection values available in this category of endpoints, and their corresponding collection options.

Prior to referencing the table, the following example shows how you can replace the {collection} placeholder.

How to Replace the {collection} Placeholder

The following example URL has a {collection} placeholder. This placeholder needs to be filled in with a Collection Option prior to making an API call.

https://api.getbee.io/v1/{collection}/merge-rows

As an example, if you'd like to merge rows for emails using this endpoint, replace {collection} with message.

The final URL to make the API call will be:

https://api.getbee.io/v1/message/merge-rows

The following table provides a comprehensive reference of all available options.

Resource
Collection Options

/merge

  • /message

  • /page

/merge-rows

  • /message

  • /page

/synced-rows

  • /message

  • /page

/merge-index

  • /message

  • /page

Merge

The merge method allows you to update a row across multiple templates. Specifically, it enables the host application to modify an element within an existing JSON document. This means you can implement a feature that updates templates in the background—without requiring any action from your users. It's ideal for merging shared content (saved rows) into templates that use it—for example, updating the same footer across 30 different email or page templates.

Important: collection is a placeholder within the URL. This placeholder can be replaces with any of the collection options available for the Row Processing resource. Reference the Row Processing Resource and Collection Options table for a list of available option.

URL: https://api.getbee.io/v1/{collection}/merge

Merge to replace or update content

post

Replace or update content in a Beefree template using a specific path and value. Compatible with Email and Page builders.

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
post
/v1/{collection}/merge

Merge Rows

URL: https://api.getbee.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
post
/v1/{collection}/merge-rows

When utilizing this feature, it's important to consider adding a handle to the metadata. This handle serves a crucial role in functions such as onDeleteRow and onEditRow. In our provided example, we use a handle named guid. However, users have the flexibility to choose their own handle name according to their preferences and requirements. When selecting a handle name, we recommend you choose something descriptive and meaningful for ease of identification and management within your workflow.

Synced Rows

URL: https://api.getbee.io/v1/{collection}/synced-rows

What if a footer is shared by 10 messages and needs to be updated in all of them? The Synced Rows feature was created precisely to address the scenario of content that is shared across multiple emails, pages, or popups, and it is used in conjunction with the Content Services API.

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
post
/v1/{collection}/synced-rows

Index

The index method in the Content Services API lets you retrieve a list of assets that include a specific saved row. This method is essential for determining which assets need to be updated using the merge method.

Typical Use Cases

  • Updating shared headers or footers across multiple templates

  • Modifying expiration dates in seasonal campaigns

  • Applying price or link changes to reused promotional content

  • Making any update to shared blocks without manually editing each message

Use the index method first to locate all impacted assets, then apply changes with the merge method to ensure content is updated consistently.

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
post
/v1/{collection}/merge/index
PreviousConvertNextAI Collection

Last updated

Was this helpful?