JSON API » ingroups » ingroups/update

Updates an existing inbound group.

Input parameters

Requires authentication and the system role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of inbound group to update.	Yes
bill_cards	Integer	1 to bill calling cards for inbound calls via this inbound group, 0 not to.	No	Current value.
callerid	Integer	1 if this inbound group may be used as callerid, 0 if not.	No	Current value.
callerid_location	Integer	1 if this inbound group may be used as location callerid, 0 if not. Has no effect unless location callerid is configured.	No	Current value.
cnam_lookup	Integer	1 to perform CNAM lookups on calls to numbers. 0 not to.	No	Current value.
code	String	Area code.	No	Current value.
currency	String	Currency inbound call costs are in.	No	Current value.
description	String	Description.	No	Current value.
included	Integer	1 if calls to this inbound group counts towards included call time, 0 if not.	No	Current value.
minimum_pool	Integer	Minimum number of spare numbers. If fewer, system will topup using number vendors. 0 to disable.	No	Current value.
name	String	Name.	No	Current value.
name_invoices	String	Name as shown on invoices. Empty string to use name.	No	Current value.
ported	Integer	1 if ported numbers are put in this inbound group, 0 if not. Setting to 1 sets all other ingroups to 0.	No	Current value.
signup	Integer	1 if this inbound group may be used in signup, 0 if not.	No	Current value.
tags	String	Tags.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

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.
404	The inbound group does not exist.

Data returned

No data is returned.

Example: Changing the name

http://enswitch.example.com/api/json/ingroups/update/?auth_username=user;auth_password=password;id=123;name=example

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

Change history

Version	Changes
3.13	Function added.