JSON API » calleridgroups » calleridgroups/update
Updates an existing callerid group, used for numbers to route some callers to alternative destinations.
Input parameters
Requires authentication and the administrator role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
id | Integer | ID of callerid group to update. | Yes | |
description | String | Description. | Yes | |
name | String | Name. | Yes | |
shared | Integer | 1 to share with all customers recursively, 0 not to. Only has effect with commerce role privilege. | No | Current value. |
Responses
Code | Description |
---|---|
201 | Input passed validation. Only returned if validation=1. |
204 | Success. |
400 | Invalid input parameters specified. Check the key and message fields for more details. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
403 | Your rate plan does not allow this. |
404 | The callerid group does not exist, or you do not have permission to update it. |
Data returned
No data is returned.
Example: Changing the name and description
http://enswitch.example.com/api/json/calleridgroups/update/?auth_username=user;auth_password=password;id=123;name=example;description=description{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
Version | Changes |
---|---|
4.3 | Function added. |