Job.SetParameter
- 14 May 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Job.SetParameter
- Updated on 14 May 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Description
Set a custom parameter on an active job.
URL parameters
| Name | Required | Type | Description |
|---|---|---|---|
JobID | True | string | Job ID number. |
JobParameter.<ParameterName> | True | string | The names and values of the parameters you want to set in the current active job. |
Returns
| Name | Type | Description |
|---|---|---|
Result | string | Success if the operation was successful. |
Sample request
curl -X GET 'https://api.mozenda.com/rest??WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Job.SetParameter&ResponseFormat=JSON&JobID=1314&JobParameter.<Code>=123456789'
Sample responses
XML
<?xml version="1.0" encoding="utf-8"?>
<WebServiceResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Result>Success</Result>
</WebServiceResponse>
JSON (add &ResponseFormat=JSON)
{
"JsonResult": {
"Command": "Job.SetParameter",
"AutoLoggedIn": true,
"WebConsoleKey": "",
"Result": "Success",
}
}
Was this article helpful?