PUT api/v1/companies/{companyUid}
Updates the company by the specified company UID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyUid |
The company UID. |
globally unique identifier |
Required |
Body Parameters
The company.
Company| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
The company name. |
string |
Required String length: inclusive between 0 and 100 |
| AddressLine1 |
The address line1. |
string |
String length: inclusive between 0 and 100 |
| AddressLine2 |
The address line2. |
string |
String length: inclusive between 0 and 100 |
| AddressLine3 |
The address line3. |
string |
String length: inclusive between 0 and 100 |
| AddressLine4 |
The address line4. |
string |
String length: inclusive between 0 and 100 |
| PostCode |
The post code. |
string |
String length: inclusive between 0 and 50 |
| Country |
The country. |
globally unique identifier |
None. |
| Latitude |
The latitude. |
string |
String length: inclusive between 0 and 10 |
| Longitude |
The longitude. |
string |
String length: inclusive between 0 and 10 |
Request Formats
application/json, text/json
{
"Name": "sample string 1",
"AddressLine1": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine3": "sample string 4",
"AddressLine4": "sample string 5",
"PostCode": "sample string 6",
"Country": "b2b4b624-104c-4396-adc4-7b47d5c63352",
"Latitude": "sample string 8",
"Longitude": "sample string 9"
}
application/xml, text/xml
<Company xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models"> <AddressLine1>sample string 2</AddressLine1> <AddressLine2>sample string 3</AddressLine2> <AddressLine3>sample string 4</AddressLine3> <AddressLine4>sample string 5</AddressLine4> <Country>b2b4b624-104c-4396-adc4-7b47d5c63352</Country> <Latitude>sample string 8</Latitude> <Longitude>sample string 9</Longitude> <Name>sample string 1</Name> <PostCode>sample string 6</PostCode> </Company>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Returns response message.
CompanyViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
The company name. |
string |
None. |
| AddressLine1 |
The address line1. |
string |
None. |
| AddressLine2 |
The address line2. |
string |
None. |
| AddressLine3 |
The address line3. |
string |
None. |
| AddressLine4 |
The address line4. |
string |
None. |
| PostCode |
The post code. |
string |
None. |
| Country |
The country. |
CountryViewModel |
None. |
| Latitude |
The latitude. |
string |
None. |
| Longitude |
The longitude. |
string |
None. |
| PortalUid |
The portal uid that this company belongs |
globally unique identifier |
None. |
| PortalGuid |
The portal guid that this company belongs |
globally unique identifier |
None. |
| CompanyGuid |
The company guid |
globally unique identifier |
None. |
| Uid |
The GUID. |
globally unique identifier |
None. |
| Links |
The links. |
Collection of Link |
None. |
| DateUpdated |
Last time the record was updated |
date |
None. |
| UpdatedBy |
Who updated the record last |
string |
None. |
Response Formats
application/json, text/json
{
"Name": "sample string 1",
"AddressLine1": "sample string 2",
"AddressLine2": "sample string 3",
"AddressLine3": "sample string 4",
"AddressLine4": "sample string 5",
"PostCode": "sample string 6",
"Country": {
"Iso3Code": "sample string 1",
"Name": "sample string 2",
"Portal": {
"Name": "sample string 1",
"Uid": "e11cacc5-4082-4788-881d-94f19702a15b",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-10-27T13:56:00.4057597+00:00",
"UpdatedBy": "sample string 3"
},
"CountryGuid": "e7960b76-6d85-4359-b644-2e184e0b8d80",
"Uid": "35d894f5-90b8-4ffe-be77-cc09c4bf45ad",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-10-27T13:56:00.4057597+00:00",
"UpdatedBy": "sample string 5"
},
"Latitude": "sample string 7",
"Longitude": "sample string 8",
"PortalUid": "d5882d4b-ab49-44de-93c7-e9430a0c4865",
"PortalGuid": "84b88e41-8f2c-48ae-9ebb-d12f216e5409",
"CompanyGuid": "019310ff-da39-4458-867b-9bc494f7b6b5",
"Uid": "3b4328a5-db60-41b0-a790-9f83f05b3a0d",
"Links": [
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
},
{
"Href": "http://webapihelppage1.com",
"Method": "sample string 2",
"Rel": "sample string 3",
"Title": "sample string 4",
"Type": "sample string 5"
}
],
"DateUpdated": "2025-10-27T13:56:00.4057597+00:00",
"UpdatedBy": "sample string 13"
}
application/xml, text/xml
<CompanyViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
<DateUpdated>2025-10-27T13:56:00.4057597+00:00</DateUpdated>
<Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
<d2p1:Link>
<d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
<d2p1:Method>sample string 2</d2p1:Method>
<d2p1:Rel>sample string 3</d2p1:Rel>
<d2p1:Title>sample string 4</d2p1:Title>
<d2p1:Type>sample string 5</d2p1:Type>
</d2p1:Link>
</Links>
<Uid>3b4328a5-db60-41b0-a790-9f83f05b3a0d</Uid>
<UpdatedBy>sample string 13</UpdatedBy>
<AddressLine1>sample string 2</AddressLine1>
<AddressLine2>sample string 3</AddressLine2>
<AddressLine3>sample string 4</AddressLine3>
<AddressLine4>sample string 5</AddressLine4>
<CompanyGuid>019310ff-da39-4458-867b-9bc494f7b6b5</CompanyGuid>
<Country>
<DateUpdated>2025-10-27T13:56:00.4057597+00:00</DateUpdated>
<Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
<d3p1:Link>
<d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
<d3p1:Method>sample string 2</d3p1:Method>
<d3p1:Rel>sample string 3</d3p1:Rel>
<d3p1:Title>sample string 4</d3p1:Title>
<d3p1:Type>sample string 5</d3p1:Type>
</d3p1:Link>
</Links>
<Uid>35d894f5-90b8-4ffe-be77-cc09c4bf45ad</Uid>
<UpdatedBy>sample string 5</UpdatedBy>
<CountryGuid>e7960b76-6d85-4359-b644-2e184e0b8d80</CountryGuid>
<Iso3Code>sample string 1</Iso3Code>
<Name>sample string 2</Name>
<Portal>
<DateUpdated>2025-10-27T13:56:00.4057597+00:00</DateUpdated>
<Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
<d4p1:Link>
<d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
<d4p1:Method>sample string 2</d4p1:Method>
<d4p1:Rel>sample string 3</d4p1:Rel>
<d4p1:Title>sample string 4</d4p1:Title>
<d4p1:Type>sample string 5</d4p1:Type>
</d4p1:Link>
<d4p1:Link>
<d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
<d4p1:Method>sample string 2</d4p1:Method>
<d4p1:Rel>sample string 3</d4p1:Rel>
<d4p1:Title>sample string 4</d4p1:Title>
<d4p1:Type>sample string 5</d4p1:Type>
</d4p1:Link>
</Links>
<Uid>e11cacc5-4082-4788-881d-94f19702a15b</Uid>
<UpdatedBy>sample string 3</UpdatedBy>
<Name>sample string 1</Name>
</Portal>
</Country>
<Latitude>sample string 7</Latitude>
<Longitude>sample string 8</Longitude>
<Name>sample string 1</Name>
<PortalGuid>84b88e41-8f2c-48ae-9ebb-d12f216e5409</PortalGuid>
<PortalUid>d5882d4b-ab49-44de-93c7-e9430a0c4865</PortalUid>
<PostCode>sample string 6</PostCode>
</CompanyViewModel>