Agent.Move

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

Moving an existing agent from one account to a different account.

To find the DestinationAccountKey, go to your Departments list,
or
Go to Web Console > Click > Click Account Settings > Account Information.

Avoid running 3 Agent.Move/Agent.Copy processes at once.

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
`Agent ID`	True	numeric	Unique identifier of the agent that will be moved.
`DestinationAccountKey`	True	string	Unique identifier of the new account destination for the agent that will be moved.
`AgentGroupID`	False	numeric	Unique identifier of the agent group.
`CopyData`	False	boolean	Yes, No, True, False. Yes/True to copy the agent's data.
`IncludeAgentRunSchedule`	False	boolean	Yes, No, True, False. Yes/False* to include agent run schedule.
`IncludePublishSettings`	False	boolean	Yes, No, True, False. Yes/False to include publish settings.
`IncludeAgentNotifications`	False	boolean	Yes, No, True, False. Yes/False to include agent notifications.
`Name`	False	string	Name of the agent that will be moved.

Responses

Name	Type	Description
`Result`	string	`Success` if the operation was successful.
`BatchID`	numeric	Unique identifier used to monitor the progress of the `Agent.Move` Get request.

Note

Get the status of the API call of the moved agent in Agent.GetMoveCopyStatus.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX -XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Agent.Move&AgentID=1044&DestinationAccountKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

Sample responses

XML

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

JSON (add `&ResponseFormat=JSON`)

{
"BatchID": 32555,
   "JsonResult": {
      "Command": "Agent.Copy",
      "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
      }
   }
}

Was this article helpful?

What's Next

Job.Get