Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.
BetaStarter EditionEssentials EditionPro EditionEnterprise Edition

Bulk Upload Product Boost Campaigns

You can use the bulk uploads tool to create or modify multiple Product Boost campaigns at once rather than individually. You'll use a CSV or Excel file to provide details for the fields you would otherwise fill in manually.

1

Prepare your file

  1. Copy this template file to your device:

Campaign Name,Method,Campaign ID,Vendor ID,Internal Campaign ID,Funding,Eligibility Type,Partner IDs,Partner Group IDs,Budget,Enforced Budget,Draft,Start Date,End Date,Event Type ID,Payout Type,Payout Value,Precedence,Rules
Winter Boot Promo,Add,,,EXAMPLE-001,,JOINED_PARTNERS,,,1000.00,no,yes,2026-08-01T00:00:00-07:00,2026-08-31T23:59:59-07:00,17897,FIXED,5.00,10,[ITEM_SKU IS BOOT123]
  1. Replace the sample row with your own campaign details and fill in one row for each campaign you want to create.

  2. Check your fields against the File format reference below to ensure you enter correct data and in their required formats.

  3. Save the edits to your file with an appropriate name, e.g., Product_Boost_Bulk_Create. Make sure the file saves in .csv or .xlsx format.

  1. Copy this template file to your device:

Campaign Name,Method,Campaign ID,Vendor ID,Internal Campaign ID,Funding,Eligibility Type,Partner IDs,Partner Group IDs,Budget,Enforced Budget,Draft,Start Date,End Date,Event Type ID,Payout Type,Payout Value,Precedence,Rules
Summer Sandal Promo,Modify,1234,,EXAMPLE-002,,PARTNER_GROUPS,,,1234.00,yes,yes,2026-08-01T00:00:00-07:00,2026-08-31T23:59:59-07:00,17897,FIXED,5.00,10,[ITEM_SKU IS BOOT123]
  1. Replace the sample row with the campaign's new details and fill in one row for each campaign you want to edit.

    • Ensure the Method field indicates you're trying to Modify a campaign.

    • Ensure the Campaign ID field indicates which campaign you're trying to edit.

    • A campaign's payout groups can only be replaced as a complete set. To add multiple payout group rules to a single campaign, see Bulk Upload Multiple Product Boost Payout Rules.

  2. Check your fields against the Modifiable fields reference below to ensure you only edit supported fields and in their required formats.

  3. Save the edits to your file with an appropriate name, e.g., Product_Boost_Bulk_Edit. Make sure the file saves in .csv or .xlsx format.

It's also possible to create new campaigns and modify existing ones in a single file upload. The value you enter in each row's Method field will indicate whether you're trying to create a campaign or editing an existing one.

2

Upload your campaigns

  1. From the left navigation bar, select [Engage] → Campaign Manager → Product Boost.

  2. In the upper-right corner of the screen, select Bulk Upload.

  3. Select Choose File or drag and drop the file you prepared for upload.

  4. Select Next.

3

Review any validation errors

  1. Review your uploaded data for errors.

    • Validation failures will be highlighted in red, with errors listed in the first column for you to address.

    • Each row represents a single campaign. To filter out rows that validated successfully, select [Checkbox] Show errors only.

  2. If there are errors in your file, select Back to return to the upload step. Refer to the validation error reference below for guidance on addressing each error.

    • When all rows are clear and show OK in the first column, your campaigns are ready to be approved.

4

Approve your upload

  1. Select Accept.

    • The new campaigns you uploaded will appear in your campaigns list.

  2. Next, learn what each Product Boost campaign status means and how to manage them.

References

Use these references as a guide when updating the placeholder row in your file with your own campaign details.

File format reference
Column Name
Required
Type
Description

Campaign Name

Yes

String

The name of the campaign.

Method

No

String

Whether you want to Add a new campaign or Modify an existing one. Leaving the field blank will default to Add.

Campaign ID

No

Integer

The system-assigned identifier for the campaign. Leave this field blank when creating campaigns.

Vendor ID

No

Integer

The ID of the vendor, if applicable. This can be obtained from your My Vendors page.

Internal Campaign ID

No

String

Your own optional identifier for this campaign.

Funding

No

String

The funding details for the campaign.

Eligibility Type

Yes

String

Identify the eligible partners who will be automatically hired. For groups or specific partners, add the IDs and comma separate them. Allowed values: JOINED_PARTNERS, PARTNER_GROUPS, INDIVIDUAL_PARTNERS

Partner IDs

No

CSV string

Comma-separated partner IDs. Required when Eligibility Type is INDIVIDUAL_PARTNERS.

Partner Group IDs

No

CSV string

Comma-separated partner group IDs. Required when Eligibility Type is PARTNER_GROUPS.

Budget

Yes

Decimal(8,2)

Total budget for the campaign.

Enforced Budget

No

Boolean

Accepted values: yes, true (end the campaign automatically when the budget is fully spent) or no, false (do not enforce). Leave blank if not interested in enforcing.

Draft

Yes

Boolean

Whether to save the campaign as a draft. Accepted values: yes, true (save as draft) or no, false (active immediately).

Start Date

Yes

Date

The date the campaign will start in ISO8601 format. Example: 2013-06-30T00:00:00-07:00

End Date

Yes

Date

The date the campaign will end in ISO8601 format. Example: 2013-06-30T00:00:00-07:00

Event Type ID

Yes

Integer

The numeric event type ID for the primary payout tracker of this campaign.

Payout Type

Yes

String

The payout type for this event (i.e PERCENTAGE or FIXED).

Payout Value

Yes

Decimal(8,2)

The payout amount for this event type. Must be greater than zero.

Precedence

Yes

Integer

Campaign priority from 1 (highest) to 10 (lowest).

Rules

Yes

String

Modifiable fields reference

For campaign modifications, note the following:

  • Only fill in the fields you want to change; a blank field keeps its current value.

  • When modifying a campaign's rules, all existing rules and event types are replaced by the upload file.

  • A campaign's status restricts which modifications will apply. Completed campaigns cannot be modified, and active campaigns cannot be reverted to draft status.

Column Name
Modifiable?
Instruction

Campaign Name

Yes

Enter the new name of the campaign.

Method

No, but required

Enter Modify to indicate you want to edit an existing campaign.

Campaign ID

No, but required

Use this field to signal which pre-existing campaign you want to modify.

Vendor ID

Only before campaign goes live

If eligible, enter the new ID of the vendor from your My Vendors page. The vendor can't be changed once the campaign is live, and can't be changed at all on a formally vendor-funded campaign.

Internal Campaign ID

Yes

Enter your own new identifier for this campaign.

Funding

Yes

Enter the new funding details for the campaign.

Eligibility Type

Yes

Indicate the new eligible partners who will be automatically hired. Allowed values: JOINED_PARTNERS, PARTNER_GROUPS, INDIVIDUAL_PARTNERS

Partner IDs

Only with Eligibility Type

Indicate the IDs of any new eligible partners. Required when Eligibility Type = INDIVIDUAL_PARTNERS.

Partner Group IDs

Only with Eligibility Type

Indicate the IDs of any new eligible Partner Groups. Required when Eligibility Type = PARTNER_GROUPS.

Budget

Yes

Enter the new total budget for the campaign.

Enforced Budget

Yes

Enter yes / true (to end the campaign automatically when the budget is fully spent) or no / false (do not enforce). Leave blank if not interested in enforcing.

Draft

No

Leave blank.

Start Date

Only if not started

Enter the new start date in ISO8601 format. Example: 2013-06-30T00:00:00-07:00

End Date

Only if not ended

Enter the new end date in ISO8601 format. Example: 2013-06-30T00:00:00-07:00

Event Type ID

Only with continuation rows

Payout Type

Only with continuation rows

Payout Value

Only with continuation rows

Precedence

Only with continuation rows

Rules

Yes

  • Enter one eligibility condition in the format [VARIABLE OPERATOR VALUE] e.g., [ITEM_SKU IS HYD-2000], or learn how to set payout rules.

  • To add multiple payout rules to a single campaign, follow the process in Bulk Upload Multiple Product Boost Payout Rules.

  • Modifying this field will erase and replace any existing rules and event types for the campaign.

For field formats and allowed values, use the File format reference above.

Validation error reference

If your uploaded data contains validation errors, find the error message below to see what's likely causing it and how to fix it.

Error message
How to fix

Limited Time Start Date is invalid

Check that your Start Date has a value, falls before End Date, and is in ISO8601 format (e.g. 2026-08-01T00:00:00-07:00).

Limited Time End Date is invalid

Check that your End Date has a value, falls after the Start Date, and is in ISO8601 format (e.g., 2026-08-30T00:00:00-07:00).

Draft is required

Enter yes/true or no/false in the Draft column to indicate whether the campaign should save as a draft or go active immediately.

Eligibility Type is required

Enter one of the three accepted values in the Eligibility Type column: JOINED_PARTNERS, PARTNER_GROUPS, or INDIVIDUAL_PARTNERS.

Precedence is required

Enter a whole number from 1 (highest priority) to 10 (lowest priority) in the Precedence column.

Start Date cannot be in the past

Update Start Date to a date in the future, formatted in ISO8601 (e.g., 2026-08-01T00:00:00-07:00).

Event Type ID does not belong to this program

The Event Type ID you entered doesn't match any event types actually linked to your program. Learn how to find your event type ID.

Rules column contains an invalid rule expression. Use the format [Variable Operator Value], chain multiple rules with AND.

Campaign ID is required when Method is Modify

Add the Campaign ID of the campaign you want to edit to every Modify row.

Campaign ID does not exist in this program

Check that the Campaign ID matches an existing Product Boost campaign in your program.

Duplicate campaign ID in this file

Each campaign can appear only once per file. Combine that campaign's changes into a single Modify row.

[Field] cannot be edited while the campaign is in Completed status.

Remove the Modify row for the completed campaign, or create a new campaign with Method = Add.

One or more Partner Group IDs do not belong to this program.

Check that each ID in Partner Group IDs matches a Partner Group in your program.

Partner Groups IDs are required when Eligibility Type is PARTNER_GROUPS

Add one or more Partner Group IDs to the Partner Group IDs column, comma-separated, or change Eligibility Type to JOINED_PARTNERS or INDIVIDUAL_PARTNERS.

Partner Groups IDs must be a comma-separated list of whole numbers.

Enter only whole numbers in Partner Group IDs, separated by commas — for example, 1024,1099,2001. Remove any spaces, letters, decimals, or other characters.

Start Date cannot be edited after the campaign has started.

The Start Date of an active campaign is locked. Leave Start Date blank on the Modify row to keep the current value, or edit only campaigns that haven't started yet.

[Field] can only be changed while the campaign is in Draft status.

Once a campaign is active, this field is locked. Leave blank to keep the current value, or create a new campaign with Method = Add.

Vendor ID does not exist or is not connected to this program.

Check that the Vendor ID matches a vendor listed on your My Vendors page. If the vendor isn't listed, you'll need to connect with them before you can fund a campaign through them.

Click event types are not supported for product boost Campaigns.

Enter an Event Type ID for a non-click event type (for example, a sale). Learn how to find your event type ID.

Last updated

Was this helpful?