POST api/v1/portals/{portalUid}/companies/sites

Creates the site by portal.

Request Information

URI Parameters

Name	Description	Type	Additional information
portalUid	The portal UID.	globally unique identifier	Required

Body Parameters

The site object.

CompanySite

Name	Description	Type	Additional information
Name	The company site name.	string	Required String length: inclusive between 0 and 100
Address1	The address line 1.	string	String length: inclusive between 0 and 100
Address2	The address line 2.	string	String length: inclusive between 0 and 100
Address3	The address line 3.	string	String length: inclusive between 0 and 100
Address4	The address line 4.	string	String length: inclusive between 0 and 100
Postcode	The post code.	string	String length: inclusive between 0 and 100
Country	The country.	string	String length: inclusive between 0 and 100
Telephone	The telephone number.	string	String length: inclusive between 0 and 100
Fax	The fax number.	string	String length: inclusive between 0 and 100
Email	The email address.	string	String length: inclusive between 0 and 100
Latitude	The latitude.	string	String length: inclusive between 0 and 20
Longitude	The longitude.	string	String length: inclusive between 0 and 20

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Address1": "sample string 2",
  "Address2": "sample string 3",
  "Address3": "sample string 4",
  "Address4": "sample string 5",
  "Postcode": "sample string 6",
  "Country": "sample string 7",
  "Telephone": "sample string 8",
  "Fax": "sample string 9",
  "Email": "sample string 10",
  "Latitude": "sample string 11",
  "Longitude": "sample string 12"
}

application/xml, text/xml

Sample:

<CompanySite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <Address1>sample string 2</Address1>
  <Address2>sample string 3</Address2>
  <Address3>sample string 4</Address3>
  <Address4>sample string 5</Address4>
  <Country>sample string 7</Country>
  <Email>sample string 10</Email>
  <Fax>sample string 9</Fax>
  <Latitude>sample string 11</Latitude>
  <Longitude>sample string 12</Longitude>
  <Name>sample string 1</Name>
  <Postcode>sample string 6</Postcode>
  <Telephone>sample string 8</Telephone>
</CompanySite>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the created site.

CompanySiteViewModel

Name	Description	Type	Additional information
Portal	The portal.	PortalViewModel	None.
Company	The company.	CompanyViewModel	None.
Name	The name.	string	None.
Address1	The address1.	string	None.
Address2	The address2.	string	None.
Address3	The address3.	string	None.
Address4	The address4.	string	None.
Postcode	The post code.	string	None.
Country	The country.	string	None.
Telephone	The telephone.	string	None.
Fax	The fax.	string	None.
Email	The email.	string	None.
Latitude	The latitude.	string	None.
Longitude	The longitude.	string	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

Sample:

{
  "Portal": {
    "Name": "sample string 1",
    "Uid": "f0a9810b-e684-4b59-b157-5b0aa78d110f",
    "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:58:17.0971859+00:00",
    "UpdatedBy": "sample string 3"
  },
  "Company": {
    "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": "f0a9810b-e684-4b59-b157-5b0aa78d110f",
        "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:58:17.0971859+00:00",
        "UpdatedBy": "sample string 3"
      },
      "CountryGuid": "e32aef98-73c6-4b13-a686-4adb560f3553",
      "Uid": "3b533f66-a021-422e-ab98-c0fda8bef090",
      "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:58:17.0971859+00:00",
      "UpdatedBy": "sample string 5"
    },
    "Latitude": "sample string 7",
    "Longitude": "sample string 8",
    "PortalUid": "840e2b6b-8503-4328-90ad-b1b441555dbb",
    "PortalGuid": "c11afc8e-a8a6-4ac2-a506-b4622edbce2a",
    "CompanyGuid": "d4fa99ee-4156-49c5-9619-eb6a74499411",
    "Uid": "59298dbf-6fec-4096-a922-765bd872aa02",
    "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:58:17.0971859+00:00",
    "UpdatedBy": "sample string 13"
  },
  "Name": "sample string 1",
  "Address1": "sample string 2",
  "Address2": "sample string 3",
  "Address3": "sample string 4",
  "Address4": "sample string 5",
  "Postcode": "sample string 6",
  "Country": "sample string 7",
  "Telephone": "sample string 8",
  "Fax": "sample string 9",
  "Email": "sample string 10",
  "Latitude": "sample string 11",
  "Longitude": "sample string 12",
  "Uid": "18f83662-c5f1-4c7d-95a1-24a9ea7ed2c0",
  "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:58:17.0971859+00:00",
  "UpdatedBy": "sample string 14"
}

application/xml, text/xml

Sample:

<CompanySiteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T13:58:17.0971859+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>18f83662-c5f1-4c7d-95a1-24a9ea7ed2c0</Uid>
  <UpdatedBy>sample string 14</UpdatedBy>
  <Address1>sample string 2</Address1>
  <Address2>sample string 3</Address2>
  <Address3>sample string 4</Address3>
  <Address4>sample string 5</Address4>
  <Company>
    <DateUpdated>2025-10-27T13:58:17.0971859+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>59298dbf-6fec-4096-a922-765bd872aa02</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>d4fa99ee-4156-49c5-9619-eb6a74499411</CompanyGuid>
    <Country>
      <DateUpdated>2025-10-27T13:58:17.0971859+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>3b533f66-a021-422e-ab98-c0fda8bef090</Uid>
      <UpdatedBy>sample string 5</UpdatedBy>
      <CountryGuid>e32aef98-73c6-4b13-a686-4adb560f3553</CountryGuid>
      <Iso3Code>sample string 1</Iso3Code>
      <Name>sample string 2</Name>
      <Portal>
        <DateUpdated>2025-10-27T13:58:17.0971859+00:00</DateUpdated>
        <Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
          <d5p1:Link>
            <d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
            <d5p1:Method>sample string 2</d5p1:Method>
            <d5p1:Rel>sample string 3</d5p1:Rel>
            <d5p1:Title>sample string 4</d5p1:Title>
            <d5p1:Type>sample string 5</d5p1:Type>
          </d5p1:Link>
          <d5p1:Link>
            <d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
            <d5p1:Method>sample string 2</d5p1:Method>
            <d5p1:Rel>sample string 3</d5p1:Rel>
            <d5p1:Title>sample string 4</d5p1:Title>
            <d5p1:Type>sample string 5</d5p1:Type>
          </d5p1:Link>
        </Links>
        <Uid>f0a9810b-e684-4b59-b157-5b0aa78d110f</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>c11afc8e-a8a6-4ac2-a506-b4622edbce2a</PortalGuid>
    <PortalUid>840e2b6b-8503-4328-90ad-b1b441555dbb</PortalUid>
    <PostCode>sample string 6</PostCode>
  </Company>
  <Country>sample string 7</Country>
  <Email>sample string 10</Email>
  <Fax>sample string 9</Fax>
  <Latitude>sample string 11</Latitude>
  <Longitude>sample string 12</Longitude>
  <Name>sample string 1</Name>
  <Portal>
    <DateUpdated>2025-10-27T13:58:17.0971859+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>f0a9810b-e684-4b59-b157-5b0aa78d110f</Uid>
    <UpdatedBy>sample string 3</UpdatedBy>
    <Name>sample string 1</Name>
  </Portal>
  <Postcode>sample string 6</Postcode>
  <Telephone>sample string 8</Telephone>
</CompanySiteViewModel>