editCampaign

Definition

The editCampaign API Command edits certain parameters in the campaign.

Cost

Using this command consumes 1 credit.

Module

The command is included in the Campaign API Module and will only consume credits assigned for Campaign API Operations.

Parameters

campaignId The ID number of the existing campaign.
campaignType (editable) Switch the type of campaign: “recurring” or “onetime”.
sitewide (editable) Change the number of links from a domain crawled (1-20).
excludeInternalLinks (editable) Change Ignore internal links (yes or no).
campaignName (editable) Change the name of the campaign.

 

Input URL Example

 

http://api.cognitiveseo.com/command.php?apiKey=your_api_key&command=editCampaign&campaignId=8&campaignType=recurring&sitewide=5&excludeInternalLinks=yes&campaignName=test 

Output Example

Running this command will result in the following JSON output:

{
    "api": "cognitiveSEO API",
    "data": {
        "status": "success",
        "credits": 1
    },
    "time": 0.251
}

Output Details

status The status of the command (success or error).
credits The credit cost of the command.
time The time it took for the command to take place.
Go Top