PUT Environment (Update)

To update an Environment account, use a PUT with the Environment API found at our API Explorer.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb.
The format query string parameter controls the desired response format.  Specify either XML or JSON.

/api/v2/environment?format=xml/json

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.

---

Endpoints & API Explorer

Node	API Endpoint	API Explorer
US	api/v2/environment	Model Description/Schema & Parameters

---

Parameters

The PUT verb on the Environment API allows you to update details on an Environment in your Enterprise Toolkit Master Account. The required and optional parameters for a POST call to the Environment API are outlined below: 

Name	Type	Description	Required
Name	String	Name of the new environment you want to create	✓
Description	String	A description of the new environment you want to create	✓
Country	String	The ISO 3166-2 code for this Enterprise Toolkit account’s base country.
TimeZone	String	Name of timezone, must match exactly with one of the values in this list
DateFormat	String
TimeFormat	String
FillRepeatRows	Boolean	Whether or not to copy down repeatable answer values when exporting repeatable data to tabular formats like CSV
SendInviteEmailsTo	String
DefaultSenderEmail	String	The email address to use as the default for emails sent from the platform by this Enterprise Toolkit account
DefaultSenderName	String	The sender name to use as the default for emails sent from the platform by this Enterprise Toolkit account
GlobalFormRESTUrl	String
GlobalTaskRESTUrl	String
GlobalDataSourceGETUrl	String
RetireDate	Date
Industry	String
AddSupportUser	Boolean	Whether or not to automatically create a support user as part of the Enterprise Toolkit creation
SupportUserEmail	String	Allows you to specify the email address of the support user to be created. If blank, then DefaultSenderEmail is used.
CopyCustomIcons	Boolean	By default, custom icons are not copied into new contexts. Set to ‘True’ to preserve the custom icon settings.
IntegrationKey	String	Your unique Integration Key found on the Organisation Setup page of the secure website.	✓
MasterId	Integer	The Organization ID of your Master account.	✓

---

Example

Given that the API is REST-based, you can access the API directly via your web browser to test it using a REST plugin like the Postman plugin for Google Chrome.

Request URL

https://eforms.mobileform.net:443/api/v2/environment

Request Body

{
  "Environment": {
    "Id": xxxxx,
    "TimeZoneOffSet": 0,
    "Status": "Active",
    "IntegrationKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "MasterId": xxxxx
  }
}

Response Code

200

Response Body

{
  "Environment": {
    "Id": xxxxx,
    "TimeZoneOffSet": 0,
    "Status": "Active",
    "IntegrationKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "MasterId": xxxxx
  }
}

• Related Articles

• PUT Repository API (Update)

  This API call allows you to update a repository item. Enables scenarios where items in your repository can be updated by 3rd party systems quickly and easily. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST PUT ...

• PUT Usergroup

  This API allows you to update an existing user group. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST PUT verb. The format query string parameter controls the desired response format. Specify either XML or JSON. ...

• PUT Company

  This request method lets you update existing company details through the API by specifying the company details as parameters. This API call allows you to update a repository item. Enables scenarios where items in your repository can be updated by 3rd ...

• POST Environment (Create)

  To create an Environment account, use a POST 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 ...

• PUT Screen

  The PUT Screen Form API allows you to update an existing form screen. Enables scenarios where 3rd party systems can make edits/changes to forms for whatever reason. Everything from form name, description, fields, etc…can be edited and updated using ...