JSON API » customers » customers/move

Moves a customer to a new parent and rate plan.

Input parameters

Requires authentication and the system role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of customer to move.Yes
parentIntegerID of new parent.Yes
planIntegerID of new rate plan.Yes

Responses

CodeDescription
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
404The customer does not exist.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/customers/move/?auth_username=user;auth_password=password;id=123;parent=2;plan=12

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

VersionChanges
3.13Function added.