updateCampaignsStep - Medusa Core Workflows Reference
This documentation provides a reference to the updateCampaignsStep. It belongs to the @medusajs/medusa/core-flows package.
This step updates one or more campaigns.
Example#
Input#
UpdateCampaignDTO[]UpdateCampaignDTO[]
UpdateCampaignDTO[]UpdateCampaignDTO[]idstringThe ID of the campaign.
idstringnamestringOptionalThe name of the campaign.
namestringOptionaldescriptionnull | stringOptionalThe description of the campaign.
descriptionnull | stringOptionalcampaign_identifierstringOptionalThe campaign identifier of the campaign.
campaign_identifierstringOptionalstarts_atnull | DateOptionalThe start date of the campaign.
starts_atnull | DateOptionalends_atnull | DateOptionalThe end date of the campaign.
ends_atnull | DateOptionalThe budget of the campaign.
Output#
CampaignDTO[]CampaignDTO[]
CampaignDTO[]CampaignDTO[]idstringThe ID of the campaign.
idstringnamestringOptionalThe name of the campaign.
namestringOptionaldescriptionstringOptionalThe description of the campaign.
descriptionstringOptionalcampaign_identifierstringOptionalThe campaign identifier of the campaign.
campaign_identifierstringOptionalstarts_atDateOptionalThe start date of the campaign.
starts_atDateOptionalends_atDateOptionalThe end date of the campaign.
ends_atDateOptionalThe associated campaign budget.
The associated promotions.
Was this page helpful?