Search Knowledge Base by Keyword
PUT Environment (Update)
To update an Environment account, use a PUT with the Environment API found at our API Explorer.
On our Cloud service, this API is available via SSL secured HTTPS connection using the REST GET, POST and PUT verbs.
The format query string parameter controls the desired response format. Specify either XML or JSON.
NOTE: This API endpoint implements pagination, and as such you must cater for this when you connect to our platform.
You can learn more about pagination in our API overview.
The PUT verb allows you to update a single, existing Environment on the platform.
You may use either JSON or XML formats in your request.
You indicate this by setting the ContentType HTTP header as “application/json” or “application/xml”. If no ContentType is specified, XML format is assumed.
The required and optional parameters for a PUT to the Environment API are outlined below.
|Parameter Name||Data Type||Required||Description|
||Yes||The Environment that you wish to update. See the Environment type definition from the GET documentation topic.|
The data returned from an Environment PUT is provided as follows:
|Field Name||Data Type||Description|
|Environment||Environment||The Environment updated
||Details of any errors that may have occurred|
|Field Name||Data Type
||Unique Environment Id (Company Id) found on the Organisation Setup page>Integrations Settings of the secure website.