Knowledgebase

The Company API allows you to update existing Companies on the platform.

This enables scenarios where Companies created/maintained in other systems (e.g. SAP, Salesforce) can be replicated to the platform automatically.

CONTENTS

• PUT Request
• PUT Response
• API Usage Example

PUT Request

The PUT verb allows you to update a single, existing Company 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 format query string parameter controls the desired response format.  Specify either XML or JSON.

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

The required (red border) and optional parameters for a PUT to the Company API are outlined below.

Model Schema

PUT Response

The data returned from a Company PUT is provided as follows:

API Usage Example

Given that the API is REST-based, you can access the API directly via your web browser to test it. Obviously, for actual integration work, you will need to make a web request to the given REST URL and then parse the response.

Below is a simple PUT example that updates an existing Company using XML format.

XML Body:

<Company>
<ActiveUsers>4</ActiveUsers> 
<Id>2</Id>
<IntegrationKey>xxx</IntegrationKey>
<Name>Test Company</Name> 
<VendorId>1</VendorId>
</Company>

XML Response:

<CompanyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<ResponseStatus/>
<Company>
<Id>2</Id>
<IntegrationKey>xxx</IntegrationKey>
<Status>Active</Status>
<VendorId>1</VendorId>
</Company>
</CompanyResponse>