Sequence.Run

Updated on 14 May 2024
1 Minute to read
Contributors

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Description

Starts a specific sequence.

URL parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

Name	Required	Type	Description
`SequenceID`	True	numeric	Unique identifier of the sequence.
`StepNumber`	False	numeric	Starts the sequence at the step number specified and skips all previous steps.

Returns

Name	Type	Description
`Result`	string	`Success` if the operation was successful.
`JobID`	string	Unique identifier of the created job.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Sequence.Run&SequenceID=1001&StepNumber=1002"

Sample responses

XML

<?xml version="1.0" encoding="utf-8"?>
<SequenceRunResponse 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<JobID>15982</JobID>
</SequenceRunResponse>

JSON (add `&ResponseFormat=JSON`)

{
  "JobID":32445,
  "JsonResult":{
       "Command":"Sequence.Run",
       "AutoLoggedIn":false,
       "WebConsoleKey":"",
       "Result":"Success",
       "ErrorCode":"",
       "ErrorDescription":"",
       "ErrorList":[],
       "ExecutionTime":{
             "Ticks":0,
             "Days":0,
             "Hours":0,
             "Milliseconds":0,
             "Minutes":0,
             "Seconds":0,
             "TotalDays":0,
             "TotalHours":0,
             "TotalMilliseconds":0,
             "TotalMinutes":0,
             "TotalSeconds":0
        }
    }
}

Enterprise Feature

Please contact your sales representative at +1 (801) 995-4550 or sales@mozenda.com for more information about enabling Sequences on your account.

Was this article helpful?

What's Next

Sequence.Delete