import { EllipsisHorizontal } from "@medusajs/icons" import { Table } from "docs-ui"

export const metadata = { title: Manage Campaigns in Medusa Admin, }

{metadata.title}

In this guide, you'll learn how to view and manage campaigns.

What is a Campaign?

A campaign is a collection of promotions related to specific marketing or sales goals. A campaign also gives you granular control over promotion usages, allowing you to set up start and end dates, and budget usages that once exceeded, the promotions of the campaign can't be used anymore.

---

View Campaigns

To view the campaigns in your store, go to Promotions -> Campaigns from the sidebar.

In the list, you can see campaign details such as the name, description, and identifier. You can also search, filter, and sort the campaigns to find the specific item you are looking for.

<Note title="Tip">

Find tips to use lists effectively in this guide.

</Note>

---

Create Campaign

To create a campaign:

1. Go to Promotions -> Campaigns from the sidebar.
2. Click on the Create button in the main section's header.
3. In the form that opens:
   • Enter the campaign's name and identifier in their respective fields.
   • Optionally add a description in the Description field.
   • Optionally set a start date in the "Start date" field. Promotions in this campaign can only be used after this date.
   • Optionally set an end date in the "End date" field. Promotions in this campaign are expired after this date.
   • You can set a campaign budget of the following types:
     • Usage: How many times the promotions in the campaign can be used. Once the number of times exceed the limit, the campaign and its promotions expire.
     • Spend: The total amount that can be discounted by the promotions in the campaign. Once the total amount discounted exceeds the limit, the campaign and its promotions expire. This is not applicable to "Buy X Get Y" or "Free Shipping" promotions.
   • If you chose the Spend type, select the currency of the limit in the "Currency" field.
     • When adding promotions to the campaign later, promotions that discount a fixed amount can only be added if the currency matches the campaign budget's currency.
   • In the Limit field, you can set a campaign budget limit based on the type you chose.
     • If you chose Usage, enter the number of times the promotions in the campaign can be used.
     • If you chose Spend, enter the total amount that can be discounted by the promotions in the campaign.
   • If you chose the Usage type, you can optionally set the Limit usage per field to apply the limitation for each customer or email.
     • If you don't select any condition, the limit is applied globally. For example, if the limit is set to 5, the promotions in the campaign can be used a total of 5 times.
     • If you select "Customer", the limit is applied for each customer based on their unique identifier. For example, if the limit is set to 5, each customer can use the promotions in the campaign 5 times.
     • If you select "Customer Email", the limit is applied for each customer based on their email address. For example, if the limit is set to 5, each unique email address can use the promotions in the campaign 5 times.
4. Once you're done, click the Create button.

<Note>

The Limit usage per field is available from Medusa Admin v2.11.0. If you don't see it, request your technical team to upgrade your Medusa application.

</Note>

---

View Campaign Details

To view the details of a campaign:

1. Go to Promotions -> Campaigns from the sidebar.
2. Click on the campaign you want to view.

This opens the campaign's details page.

Campaign Statuses

In the first section's header, you can see the campaign's status. The status can be one of the following:

<Table> <Table.Header> <Table.Row> <Table.HeaderCell>Status</Table.HeaderCell> <Table.HeaderCell>Description</Table.HeaderCell> </Table.Row> </Table.Header> <Table.Body> <Table.Row> <Table.Cell>Scheduled</Table.Cell> <Table.Cell>The campaign has a start date in the future. Once the start date is reached, the campaign becomes active.</Table.Cell> </Table.Row> <Table.Row> <Table.Cell>Active</Table.Cell> <Table.Cell>The campaign is active and its promotions can be used.</Table.Cell> </Table.Row> <Table.Row> <Table.Cell>Expired</Table.Cell> <Table.Cell>The campaign has an end date that has passed. The campaign and its promotions are expired and can't be used anymore.</Table.Cell> </Table.Row> </Table.Body> </Table>

---

Edit Campaign Details

To edit the details of a campaign:

1. Go to the campaign's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the campaign's name, description, identifier, and start and end dates.
5. Once you're done, click the Save button.

---

Edit Campaign Budget Limit

To edit a campaign's budget usage or spending limit:

1. Go to the campaign's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the "Budget Limit" section's header.
3. Choose Edit from the dropdown.
4. In the side window that opens, you can edit the budget limit.
5. Once you're done, click the Save button.

---

Information that Can't be Edited in Campaign

After creating a campaign, you can't edit the following information:

1. The campaign's budget type (usage or spend).
2. The campaign's budget currency (if the type is spend).
3. The campaign's budget "limit usage per" condition (customer or customer email).

If you need to change any of this information, you should either:

1. Delete the campaign.
2. Expire the campaign by setting an end date in the past.

Then, create a new campaign with the correct information and add promotions to it.

---

Manage Promotions of Campaign

From the campaign's details page, you can manage which promotions belong to the campaign.

Add Promotions to Campaign

To add promotions to a campaign:

<Note title="Tip">

You can only add promotions that don't belong to another campaign.

</Note>

1. Go to the campaign's details page.
2. Click on the Add button in the "Promotions" section's header.
3. In the list that opens, check the promotions you want to add to the campaign.
4. Once you're done, click the Save button.

Remove Promotions from Campaign

To remove promotions from a campaign:

1. Go to the campaign's details page.
2. In the "Promotions" section, check the promotions you want to remove from the campaign.
3. Once you're done, either press <Kbd>R</Kbd> or click the Remove button at the bottom center of the page.
4. Confirm removing the promotion from the campaign by clicking the "Continue" button in the pop-up.

---

Delete Campaign

<Note type="warning">

Deleting a campaign is irreversible. Deleting a campaign doesn't delete its promotions.

</Note>

To delete a campaign:

1. Go to the campaign's details page.
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon in the first section's header.
3. Choose Delete from the dropdown.
4. Confirm deleting the campaign by clicking the "Delete" button in the pop-up.