# Campaigns

To get started, follow these steps:

## Campaign Overview page

To navigate to the campaigns overview page, click the ‘campaigns’ icon in the header of ZAP-POST.&#x20;

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FgxYPLH8tdBPRZXcO8rzV%2Fimage.png?alt=media&#x26;token=fc8db292-4b62-4699-afce-d4a2cf3b6834" alt=""><figcaption></figcaption></figure>

On the campaign overview page, you can create new campaigns, edit existing ones, or view archived campaigns. Make sure to configure the campaign settings appropriately.

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FQjjbx0s2aEh6LnHQ6ZaV%2Fimage.png?alt=media&#x26;token=ed4004fe-431b-4c6f-928d-debafced6ba8" alt=""><figcaption></figcaption></figure>

## Creating a Campaign

To create a new campaign, click the ‘add new campaign’ link at the top right of the campaign overview page, this will launch the campaign creation wizard.&#x20;

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FsQls6tfRIuese3K0eyeB%2Fimage.png?alt=media&#x26;token=8f8e2d2f-2e22-48fa-80eb-3350879973ce" alt=""><figcaption></figcaption></figure>

The first screen of the wizard requires you to choose a paper stock.

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FVWcamWnBXfuAji6rgvDR%2FCampaign-screenshot.jpg?alt=media&#x26;token=147e69f3-8612-4144-8b82-0bdf6f91b9c6" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2F2v96gAaHrYlgYYFE3CtS%2FCampaign%20wizard%20paper%20stock%20selection.png?alt=media&#x26;token=5b2fb0a1-d08c-46c4-8bf4-0f834ba9f66e" alt=""><figcaption></figcaption></figure>

### Paper stock

You have the option to select which paperstock you would like. For more information on our paperstocks and to download a template, see our academy [here](https://zappost.com/academy/lessons/zap-post-template-downloads).

After you have selected your paper stock, you can either choose to 'Use Template' or to 'Start From Scratch':

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2F4orx4iICuHH0dU5TrC6Y%2Fcreate%20a%20campaign%20first%20screen.png?alt=media&#x26;token=29a0e88e-63c2-4ce9-a457-17fded5b9444" alt=""><figcaption><p>Campaign Creation Wizard Step 1 - Campaign Type Selection</p></figcaption></figure>

### Choosing to use a template

If you choose to use a template, you will see the screen below. The templates shown will be based on your chosen sector. If you change the sector in the dropdown, you can then see the templates available for different sectors. When you have made a selection, you will have two options:\
\
1\. Next Step - Navigates to naming you campaign\
2\. Edit Fields -  Gives you ability to edit the campaign fields

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FDvpyi0ctz0soKfJhxUbe%2Fimage.png?alt=media&#x26;token=29b0e171-bf70-4e9d-bc70-d6742dd89200" alt=""><figcaption><p>Template selection page</p></figcaption></figure>

{% hint style="info" %}
You can hover over each campaign type for more information.&#x20;
{% endhint %}

### Starting from Scratch

If you choose to start from scratch, you will see the screen below. On this screen, there is a table of all of the mandatory data fields which a campaign must have in order to send out Zaps. By using the 'add new custom field' button at the bottom of this table, you can add new custom fields to one of your campaigns. This will require you to correctly set up the [custom fields](#custom-field-setup) depending on what data you want to put into your campaign. When you have made a selection, click the ‘next step’ button which will appear at the bottom right of the screen.

#### Custom Field Setup

After choosing 'start from scratch' for your campaign, you will now be able to create and edit the custom fields. These custom fields allow you to choose data specific for your campaigns and customer data to be displayed on your Direct Mail campaigns.

When selecting 'add new custom field', you will be able to create the following:<br>

| Field           | Description                                                                                                                                  |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| **Name**        | The name of the field. This will be shown in CSV templates as column headers.                                                                |
| **Description** | This will identify the use of the field to users submitting via CSV. The CSV template will contain the description below each column header. |
| **Mandatory**   | If a value must be included for the field.                                                                                                   |
| **Label**       | This will be used in the design to identify the field so that it can be replaced for submitted data.                                         |

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FJpka3aADl7hFLCF59NS2%2FField%20UI%201.png?alt=media&#x26;token=7c0d6a70-c2e6-4d2e-9d8d-2ff39ddeae15" alt=""><figcaption></figcaption></figure>

Further options on the field creation wizard include the data type. All data types are listed below, including variable fields based on each data type.

| Data Type    | Field                | Description                                         |
| ------------ | -------------------- | --------------------------------------------------- |
| **Number**   | Min Value            | The minimum number allowed                          |
|              | Max Value            | The maximum number allowed                          |
|              | Decimal Places       | The number of decimal places expected               |
|              | Example Value        | An example of a typical value that may be submitted |
| **Text**     | Min Length           | The minimum length the provided text value can be   |
|              | Max Length           | The maximum length the provided text value can be   |
|              | Example Value        | An example of a typical value that may be submitted |
| **Date**     | Date Format          | The format the date must be provided in             |
|              | Example Value        | An example of a typical value that may be submitted |
| **Time**     | Time Format          | The format the time must be provided in             |
|              | Example Value        | An example of a typical value that may be submitted |
| **Datetime** | Date and Time Format | The format the datetime must be provided in         |
|              | Example Value        | An example of a typical value that may be submitted |

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FP1xkl1H48Sbdqtpn5gh0%2FField%20UI%202.png?alt=media&#x26;token=e96903b0-ca8b-4cec-a99e-3da9a3487b1a" alt=""><figcaption></figcaption></figure>

The final customisation option when creating a new field for your template is 'Validation Expressions'. This can be used to define a collection of regular expressions (should the field require its own unique validation).

More information on regular expressions can be found here: <https://en.wikipedia.org/wiki/Regular_expression>

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2F6SaS6cfMsRSaLzKrnS2h%2FField%20UI%203.png?alt=media&#x26;token=c6066eda-c80f-4225-9db4-98b3f05e381a" alt=""><figcaption></figcaption></figure>

When you have finished setting up your field, please click the 'save changes' button in the bottom right of the page followed by the 'submit' button.<br>

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FI2mp5kqxiiAeq5gZcxBy%2Fstart%20from%20scratch.png?alt=media&#x26;token=8618c79b-b403-47e3-bd17-bc655121b9d4" alt=""><figcaption></figcaption></figure>

### Naming your Campaign

The following screen is where you will give your campaign a name. \
When you are finished naming your campaign, click the ‘next step’ button again.&#x20;

{% hint style="info" %}
The campaign name must be unique to this campaign.&#x20;
{% endhint %}

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FlaDo6hgDOxxNEItT8dMB%2FNewCampaignWizardStep2.png?alt=media&#x26;token=4a31d58c-e3d2-442d-85b6-c3d606fbab40" alt=""><figcaption><p>Campaign Creation Wizard - Campaign Name</p></figcaption></figure>

This will take you to the final screen of the campaign creation wizard where you have two options.&#x20;

1. You can press the ‘save and download CSV' button which will save the campaign and download the CSV template which you will need later to upload data into ZAP-POST.
2. You can press ‘save and exit’ which will save the campaign and take you back to the campaign overview page.

&#x20;\
You can still download the campaign CSV template from the campaign overview page at a later time.&#x20;

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2Fz2eLcsNbjfGWP4N83K4q%2FNewCampaignWizardStep3.png?alt=media&#x26;token=e2770ac5-7f37-4310-afdd-65005e87864e" alt=""><figcaption></figcaption></figure>

The final step is confirmation that you can use on of our integration partners.

<figure><img src="https://1277613767-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FyQKiT3JcaHMDXjtrjvBz%2Fuploads%2FmX5Yf6WE9Ctn2hHT4xbd%2Fimage.png?alt=media&#x26;token=a43c179f-c92b-4c97-ae31-e7e953396e04" alt=""><figcaption></figcaption></figure>

## Default Data

When sending a Zap Campaign, there is a set of required data that every campaign must have in order to send out a Zap.\
\
There are a few bits of validation around the Default Data which are important to note when trying to troubleshoot issues with data uploading via CSV or ingestion via the API.

| Name         | Mandatory Field | Validation                                         |
| ------------ | --------------- | -------------------------------------------------- |
| Customer ID  | Yes             |                                                    |
| Email        | No              |                                                    |
| Salutation   | No              |                                                    |
| Firstname    | Yes             | Up to 35 Characters in combination with Surname    |
| Surname      | Yes             | Up to 35 Characters in combination with First name |
| Company Name | No              | Up to 40 Characters                                |
| Address1     | Yes             | Up to 35 Characters                                |
| Address2     | No              | Up to 35 Characters                                |
| Address3     | No              | Up to 35 Characters                                |
| City         | No              | Up to 35 Characters                                |
| Postcode     | Yes             | Up to 15 Characters                                |
| Country      | Yes             | Only UK Currently                                  |
| Currency     | No              |                                                    |
| Language     | No              |                                                    |

## Campaign Statuses

There are four possible campaign statuses in ZAP-POST. \
These can be seen in the column marked ‘status’ on the table of your campaigns on the campaign management page.&#x20;

| Name                                          | Description                                                                                                                                                                                                                              |
| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <mark style="color:red;">**Waiting**</mark>   | The campaign requires either a design to be published or data to be uploaded.                                                                                                                                                            |
| <mark style="color:red;">**On Hold**</mark>   | The account has billing issues which need to be resolved before proceeding. Users should get in touch with their ZAP-POST client manager or contact <billing@zappost.com>                                                                |
| <mark style="color:green;">**Active**</mark>  | The campaign has had Zaps sent from it and is ready to send more                                                                                                                                                                         |
| <mark style="color:blue;">**Archived**</mark> | This will move the campaign to the ‘archived campaigns’ area which can be accessed by clicking the link on the campaign management page. This allows users to file away old campaigns, ready to be used again at a later time if needed. |
