Loading...
Was this page helpful?
Loading...
createCampaignsStep - Medusa Core Workflows Reference
This documentation provides a reference to the createCampaignsStep. It belongs to the @medusajs/medusa/core-flows package.
This step cancels one or more campaigns.
Example#
Input#
CreateCampaignDTO[]CreateCampaignDTO[]
CreateCampaignDTO[]CreateCampaignDTO[]namestringThe name of the campaign.
namestringcampaign_identifierstringThe campaign identifier of the campaign.
campaign_identifierstringdescriptionnull | stringOptionalThe description of the campaign.
descriptionnull | stringOptionalstarts_atnull | DateOptionalThe start date of the campaign.
starts_atnull | DateOptionalends_atnull | DateOptionalThe end date of the campaign.
ends_atnull | DateOptionalThe associated campaign budget.
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_atDateOptional