POST /ad_campaign/{campaign_id}/update_campaign_identification

This method can be used to change the name of a campaign, as well as modify the start or end dates.

Specify the campaign_id you want to update as a URI parameter, and configure the campaignName and startDate in the request payload.

If you want to change only the end date of the campaign, specify the current campaign name and set startDate to the current date (you cannot use a start date that is in the past), and set the endDate as desired. Note that if you do not set a new end date in this call, any current endDate value will be set to null. To preserve the currently-set end date, you must specify the value again in your request.

Call getCampaigns to retrieve a seller's campaign details, including the campaign ID, campaign name, and the start and end dates of the campaign.

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. 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

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. If you want to change only the end date of the campaign, specify the current campaign name and set startDate to the current date (you cannot use a start date that is in the past), and set the endDate as desired. Note that if you do not set a new end date in this call, any current endDate value will be set to null. To preserve the currently-set end date, you must specify the value again in your request.
`campaignName`	String	No	The new seller-defined name for the campaign. This value must be unique for the seller. If you don't want to change the name of the campaign, specify the current campaign name in this field. 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 new start date for the campaign, in UTC format (`yyyy-MM-ddThh:mm:ssZ`). If the campaign is currently `RUNNING` or `PAUSED`, enter the current date in this field because you cannot submit past or future date for these campaigns. 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 getCampaigns to retrieve the campaign_id and the campaign status (`RUNNING`, `PAUSED`, `ENDED`, and so on) for all the seller's campaigns.

endDate

String

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.

If you want to change only the end date of the campaign, specify the current campaign name and set startDate to the current date (you cannot use a start date that is in the past), and set the endDate as desired. Note that if you do not set a new end date in this call, any current endDate value will be set to null. To preserve the currently-set end date, you must specify the value again in your request.

campaignName

String

The new seller-defined name for the campaign. This value must be unique for the seller.

If you don't want to change the name of the campaign, specify the current campaign name in this field.

You can use any alphanumeric characters in the name, except the less than (<) or greater than (>) characters.

Max length: 80 characters.

startDate

String

The new start date for the campaign, in UTC format (yyyy-MM-ddThh:mm:ssZ).

If the campaign is currently RUNNING or PAUSED, enter the current date in this field because you cannot submit past or future date for these campaigns.

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 getCampaigns to retrieve the campaign_id and the campaign status (RUNNING, PAUSED, ENDED, and so on) for all the seller's campaigns.

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.