JSON API » outgroups » outgroups/update

Updates an existing outbound group.

Input parameters

Requires authentication and the system role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of outbound group to update.Yes
descriptionStringDescription.NoCurrent value.
includedInteger1 if calls to this outbound group counts towards included call time, 0 if not.NoCurrent value.
nameStringName.NoCurrent value.
name_invoicesStringName as shown on invoices. Empty string to use name.NoCurrent value.
tagsStringTags.NoCurrent value.
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.
404The 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

VersionChanges
3.13Function added.