side menu

API methods in marketing

You can use API methods to retrieve data from an external system about segments of subscriber emails, subscriber lists, and so on. For example, a segment of subscriber emails can be generated in an external system, taking into account segmentation requirements that are not implemented in BRIX. The finished segment can then be loaded into the Segments of subscriber emails app using a web request.

To view the API methods available in the Marketing workspace, to the right of the Segments of subscriber emails app name, click the gear icon and select API.

api-in-marketing-1

On the page that opens, you will see a list of available methods. You can:

  • Copy the method URL for use in requests.
  • Go to the detailed method description in the BRIX Public API.
  • View the method parameters and possible server responses.
  • Compose and test a request by obtaining its full URL and the response from the server.

For more information, see the API in apps article.

Please note that certain API methods can be used only when working with static segments: retrieve a segment from an external system, create a segment, as well as add subscribers to a segment, and delete them.