Include campaign messages

Forum|Forum|2 years ago
September 11, 2023
2 replies
84 views

Hi,

I’m migrating our calls to the v2 API, previously we used the endpoint /api/v1/campaigns which includes the subject of the campaign and all of its related attributes.

It seems, it has been migrated to a relationship called “campaign-messages”, except I can’t find in your API how to directly embed them in the /api/campaigns call.

I don’t want to be forced to call /api/campaigns/{id}/campaign-messages/ on each campaign, which is not perfect for performance reasons.

Thank you

This topic has been closed for replies.

Best answer by Kim Strauch

This is where relationships come into play. You can use an `?include=campaign-messages` query parameter to include details about the related campaign message(s) for each campaign. Each campaign will include its related campaign message(s) under the relationships key, and you can see the full data for each campaign is included under the `included` key.

In this way, you can get the details about the campaign and its message in one call. Check out more details in our Guide on Relationships.

Here’s an example of this in action:

Kim StrauchAnswer

Klaviyo Employee

This is where relationships come into play. You can use an `?include=campaign-messages` query parameter to include details about the related campaign message(s) for each campaign. Each campaign will include its related campaign message(s) under the relationships key, and you can see the full data for each campaign is included under the `included` key.

In this way, you can get the details about the campaign and its message in one call. Check out more details in our Guide on Relationships.

Here’s an example of this in action: