Projects

Projects give you one place to group everything that belongs to a single marketing initiative. Instead of hunting for the Campaigns, Emails, Segments, and other entities behind a launch, you assign them all to a Project and manage them together. A Project works like a folder that spans entity types, so you can see how the pieces of an initiative fit together and find related entities quickly.

You can assign many entity types to a Project, including:

Managing Projects

To open the Projects list, select Projects in the left main menu. From here, you can create a new Project, open an existing one, and delete Projects you no longer need. The list shows each Project along with the number of entities assigned to it.

Projects list showing the New button and the Projects entry in the left menu

Creating Projects

To create a Project:

  1. Select New.

  2. Give it a name and an optional description.

Create new Project screen with Name and Description fields

Each Project name must be unique. If you enter a name that’s already in use, Mautic displays “A project with this name already exists.” and asks you to choose another.

Editing Projects

You can edit a Project’s name and description at any time. There are two ways to do this.

  1. From the Projects list:

    1. Click the three-dots icon next to the Project you want to edit.

    2. Click Edit to open the Edit Project screen.

    3. Edit the Project and click Save or Save & Close to save it.

    Projects list with the Options menu open and the Edit action highlighted

  2. From the Project’s detail view:

    1. Click the Project name to open its detail view.

    2. Click Edit at the top to open the Edit Project screen.

    3. Edit the Project and click Save or Save & Close to save it.

    Project detail view with the Edit button highlighted at the top

Deleting Projects

There are two ways to delete Projects.

  1. To delete one or more Projects at once:

    1. Select the checkbox of the Projects you want to delete. Selecting a checkbox automatically opens a blue banner on top of the table.

    2. Click Delete selected.

    3. Confirm the deletion.

    Projects list with two Projects selected and the Delete selected banner

  2. To delete a single Project:

    1. Click the three-dots icon next to the Project you want to delete.

    2. Select Delete.

    3. Confirm the deletion.

    Projects list with the Options menu open and the Delete action highlighted

Deleting a Project removes the references to it from every assigned entity, but it doesn’t delete the entities themselves.

Assigning entities to a Project

There are two ways to assign entities to a Project.

  1. From the entity - When you create or edit a supported entity, such as an Email or a Campaign, use the Projects field to assign it to one or more Projects. If you have permission to create Projects, you can also type a new name in this field and select Hit enter to create to make a new Project on the spot.


    Email edit view with the Projects field used to assign the Email to a Project

  2. From the Project:

    1. Open a Project and select Add Entities to Project.


      Project detail view highlighting the Add Entities to Project button

    2. Choose the type of entity you want to add.

    3. Select the entity you want to add to the Project.

Deleting entities from Projects

To delete an entity from a Project:

  1. Click the three-dots icon next to the entity you want to remove.

  2. Click the Remove from project button.

  3. Confirm the removal.

Options menu on a Project entity showing the Remove from project action

Finding entities by Project

To see entities assigned to a Project, go to the Project dashboard. From the Projects list, select the Project’s name or the entities label in the # Entities column. Both open the Project’s detail view, where Mautic lists every assigned entity grouped by type. From here, you can also remove entities or add new ones.

If you have many Projects, use the search bar at the top of the Projects list to find one quickly:

  1. Type the Project’s name.

  2. Press Enter.

  3. Select the Project’s name or its entities label to open it.

Projects list with a Project name typed in the search bar and the entities label highlighted

Permissions

Projects use their own permission set, which you can grant per Role. To configure these permissions:

  1. Go to Settings > Roles

  2. Open or create a Role

  3. Find the Project permissions section.

Alongside the standard View, Edit, Create, Delete, and Full permissions, there’s a separate Associate with other entities permission that controls whether a User can attach entities to and detach entities from Projects. A User needs this permission to use the Projects field on an entity or the add and remove actions on a Project.

For more information on creating Roles and configuring their permissions, see Roles overview and Setting Role permissions.