POST /ad_campaign/{campaign_id}/clone

This method clones (makes a copy of) the specified campaign's campaign criterion. The campaign criterion is a container for the fields that define the criteria for a rule-based campaign.

To clone a campaign, supply the campaign_id as a path parameter in your call. There is no request payload.

The ID of the newly-cloned campaign is returned in the Location response header.

Call getCampaigns to retrieve a seller's current campaign IDs.

Requirement: In order to clone a campaign, the campaignStatus must be ENDED and the campaign must define a set of selection rules (it must be a rules-based campaign).

Note: This method only applies to the Cost Per Sale (CPS) funding model; it does not apply to the Cost Per Click (CPC) funding model. See Funding Models in the Promoted Listings Playbook for more information.

Servers

https://api.ebay.com{basePath}

Path parameters

Name	Type	Required	Description
`campaign_id`	String	Yes	A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. This ID is the campaign ID of the campaign being cloned. Note: You can retrieve the campaign IDs for a specified seller using the getCampaigns method.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`endDate`	String	No	The date and time the campaign ends, in UTC format (`yyyy-MM-ddThh:mm:ssZ`). If this field is omitted, the campaign will have no defined end date, and will not end until the seller makes a decision to end the campaign with an endCampaign call, or if they update the campaign at a later time with an end date.
`campaignName`	String	No	A seller-defined name for the newly-cloned campaign. This value must be unique for the seller. You can use any alphanumeric characters in the name, except the less than (<) or greater than (>) characters. Max length: 80 characters
`startDate`	String	No	The date and time the cloned campaign starts, in UTC format (`yyyy-MM-ddThh:mm:ssZ`). For display purposes, convert this time into the local time of the seller. On the date specified, the service derives the keywords for each listing in the campaign, creates an ad for each listing, and associates each new ad with the campaign. The campaign starts after this process is completed. The amount of time it takes the service to start the campaign depends on the number of listings in the campaign. Call getCampaign to check the status of the campaign.
`fundingStrategy`	Object	No	This type defines how the Promoted Listings fee is calculated for a Promoted Listings ad campaign.
`fundingStrategy.fundingModel`	String	No	Indicates the model that eBay uses to calculate the Promoted Listings fee. For a description of the funding model types, refer to FundingModelTypeEnum. For implementation help, refer to eBay API documentation
`fundingStrategy.bidPercentage`	String	No	The user-defined bid percentage (also known as the ad rate) sets the level that eBay increases the visibility in search results for the associated listing. The higher the bidPercentage value, the more eBay promotes the listing. The value specified here is also used to calculate the Promoted Listings fee. This percentage value is multiplied by the final sales price to determine the fee. The Promoted Listings fee is determined at the time the transaction completes and the seller is assessed the fee only when an item sells through a Promoted Listings ad campaign. The bidPercentage is a single precision value that is guided by the following rules: These values are valid: `4.1`, `5.0`, `5.5`, ... These values are not valid: `0.01`, `10.75`, `99.99`, and so on. This is the default bid percentage for the campaigns using the Cost Per Sale (CPS) funding model, and this value will be overridden by any ads in the campaign that have their own set bid percentages. If a bid percentage is not provided for an ad, eBay uses the default bid percentage of the associated campaign. Note:This field is only relevant for campaigns that use the CPS funding model. It is not used for campaigns that use the Cost Per Click (CPC) funding model. Minimum value: 2.0 Maximum value: 100.0
`fundingStrategy.adRateStrategy`	String	No	The ad rate strategy that shall be applied to the campaign. For implementation help, refer to eBay API documentation
`fundingStrategy.dynamicAdRatePreferences[]`	Array	No	A field that indicates whether a single, user-defined bid percentage (also known as the ad rate) should be used, or whether eBay should automatically adjust listings to maintain the daily suggested bid percentage. Note: Dynamic adjustment is only applicable when the adRateStrategy is set to `DYNAMIC`. Default: `FIXED`
`fundingStrategy.dynamicAdRatePreferences[].adRateCapPercent`	String	No	The maximum value (specified as a percentage) to which the eBay suggested ad rate can be adjusted. The adjusted ad rate will never exceed this percentage.
`fundingStrategy.dynamicAdRatePreferences[].adRateAdjustmentPercent`	String	No	The percentage above or below (-) the eBay suggested ad rate that a seller is willing to pay. This specifies the maximum and minimum values to which an ad rate can be dynamically adjusted.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.