JSON API » domains » domains/update

Updates an existing domain.

Input parameters

Requires authentication and the domains role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of domain to update.	Yes
customer	Integer	ID of customer who may use this domain in SIP addresses. 0 for none, -1 for all.	No	Current value.
description	String	Description.	No	Current value.
domain	String	Domain.	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 domain does not exist.

Data returned

No data is returned.

Example: Changing the domain

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

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

Change history

Version	Changes
3.13	Function added.