JSON API » plans » plans/ingroups/update

Updates an existing rate plan inbound group.

Input parameters

Requires authentication and the commerce role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
includedInteger1 if included, 0 if not.Yes
ingroupIntegerID of inbound group.Yes
planIntegerID of rate plan.Yes
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
201Input passed validation. Only returned if validation=1.
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.
403Your rate plan does not allow this.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/plans/ingroups/update/?auth_username=user;auth_password=password;ingroup=1;plan=2;included=1

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

Change history

VersionChanges
3.13Function added.