This request method lets you create a new company account through the API, specifying the company details as parameters.

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.

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

Parameters

The POST verb for the Company API allows you to create a new company through our API, using your VendorId. The required and optional parameters for a POST call to the Company API are outlined below. 

The required and optional parameters for a POST call to the Company API are outlined below.

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

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

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

Request Body

{
  "Name": "Acme Inc",
  "Description": "The all-purpose company",
  "IntegrationKey": "dXXXXXXXXXXXXXXXXXXXXX",
  "VendorId": 8XXXX
}

Response Body

{
  "Company": {
    "Id": 9XXXX,
    "TimeZoneOffSet": 0,
    "Status": "Active",
    "IntegrationKey": "aXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "VendorId": 8XXXX
  }
}