JSON API » timegroups » timegroups/update

Updates an existing time group.

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 time group to update.	Yes
active	Integer	1 if time group is active when any time period is active, 0 if time group is active when no time periods are active.	No	Current value.
description	String	Description.	No	Current value.
name	String	Name.	No	Current value.
priority	Integer	Priority from 1 to 10.	No	Current value.
shared	Integer	1 to share with all customers recursively, 0 not to. Only has effect with commerce role privilege.	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.
403	Your rate plan does not allow this.
404	The time 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/timegroups/update/?auth_username=user;auth_password=password;id=123;name=example

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

Change history

Version	Changes
4.1	shared input parameter changed to mean customers recursively.
3.13	Function added.