PUT Company

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 party systems quickly and easily.

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.

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

You may use either JSON or XML formats in your PUT 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.

All XML formatted requests must specify the following XML namespace in the data source root element: xmlns:i=”http://www.w3.org/2001/XMLSchema-instance”

Endpoints & API Explorer

NodeAPI EndpointAPI Explorer
US/api/v2/companyModel Description/Schema & Parameters

Parameters

The PUT verb for the Company API allows you to update a specific company’s account details. The required and optional parameters for a PUT call to the Company API are outlined below (check the API Explorer page to see all properties supported).

NameTypeDescriptionRequired
IdIntegerThe company Id of the company you want to update✓
NameStringThe company name✓
DescriptionStringThe company description✓
CountryStringThe ISO 3166-2 code for this company’s base country.
TimeZoneStringThe timezone of the company
SendNotificationsToStringEmail address to send system notifications to for this company
StatusString
Active/Retired
IntegrationKeyStringYour unique Integration Key found on the Company Setup page of the secure website.✓
VendorIdIntegerYour unique vendor account identifier.✓

Example

Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.

Request URL

PUT https://eforms.mobileform.net:443/api/v2/company

Request Body

{
  "Id": 9XXXX,
  "Name": "The ACME Corporation",
  "Description": "The all-purpose company",
  "Country": "US",
  "TimeZone": "EST",
  "DateFormat": "",
  "TimeFormat": "",
  "FillRepeatRows": false,
  "SendInviteEmailsTo": "",
  "SendNotificationsTo": "",
  "GlobalAppMapsURL": "",
  "Status": "Retired",
  "Industry": "",
  "IntegrationKey": "dXXXXXXXXXXXXXXXXXXXXXXXX",
  "VendorId": 8XXXX
}

Response Body

{
  "Company": {
    "Id": 9XXXX,
    "TimeZoneOffSet": 0,
    "Status": "Retired",
    "RetireDate": "2025-07-11T08:50:44.6469020Z",
    "IntegrationKey": "aXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "VendorId": 8XXXX
  }
}

    • Related Articles

    • 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 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 ...

    • PUT Folder

      This API call allows you to update an existing Folder’s properties. 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 ...

    • PUT User

      The PUT User API allows you to update an existing user. 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. ...

    • PUT Task

      This request method allows you to update an existing task. 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 ...