JSON API » outgroups » outgroups/update

Updates an existing outbound 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 outbound group to update.	Yes
call_pin	Integer	1 to require user restricted call PIN for calls to this outbound group, 0 for no PIN required.	No	0
callergroup	Integer	ID of caller group this inbound group will be restricted to, 0 for any caller.	No	0
description	String	Description.	No	Current value.
included	Integer	1 if calls to this outbound group counts towards included call time, 0 if not.	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.
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 outbound group does not exist.

Data returned

No data is returned.

Example: Changing the name

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

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

Change history

Version	Changes
4.4	call_pin parameter added.
4.2	callergroup parameter added.
3.13	Function added.