JSON API » huntgroups » huntgroups/update

Updates an existing hunt group.

Input parameters

Requires authentication and the residential or user role privileges.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
idIntegerID of hunt group to update.Yes
allow_forwardsInteger1 to allow destinations to forward calls, 0 not to.NoCurrent value.
descriptionStringDescription.NoCurrent value.
dnumberStringDestination number if no levels answer.NoCurrent value.
dtypeIntegerDestination type if no levels answer.NoCurrent value.
musicIntegerID of music class to play. 0 for default.NoCurrent value.
music_ringingInteger1 to play music while ringing, 0 to play ringing.NoCurrent value.
nameStringName.NoCurrent value.
ownerIntegerID of owner. 0 for none.NoCurrent value.
panelInteger1 to show in control panel, 0 not to.NoCurrent value.
recordgroupIntegerID of record group. 0 for none.NoCurrent value.
ringtimeIntegerTime to ring each level in seconds. May be overridden per level.NoCurrent value.
screenInteger1 to play the callerid, 2 to ask the caller to record their name, 0 not to screen.NoCurrent value.
typeStringType of hunt group. "circular", "linear", "smart_circular", or "smart_linear".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.
403Your rate plan does not allow this.
404The hunt group does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the name

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

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

Change history

VersionChanges
3.13Function added.