POST api/v1/portals/{portalUid}/customer/clients/{clientGuid}/sites

Creates the client site for the specified client Guid.

Request Information

URI Parameters

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

Body Parameters

The client site.

ClientSite

Name	Description	Type	Additional information
Name	The client sitename.	string	Required
AddressLine1	The client site address line 1.	string	String length: inclusive between 0 and 100
AddressLine2	The client site address line 2.	string	String length: inclusive between 0 and 100
AddressLine3	The client site address line 3.	string	String length: inclusive between 0 and 100
AddressLine4	The client site address line 4.	string	String length: inclusive between 0 and 100
PostCode	The client site postcode.	string	String length: inclusive between 0 and 50
Country	The client site country.	string	String length: inclusive between 0 and 100
Telephone	The client site telephone number.	string	String length: inclusive between 0 and 100
Fax	The client site fax number.	string	String length: inclusive between 0 and 100
Email	The client site email address.	string	String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:

{
  "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": "sample string 7",
  "Telephone": "sample string 8",
  "Fax": "sample string 9",
  "Email": "sample string 10"
}

application/xml, text/xml

Sample:

<ClientSite 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>sample string 7</Country>
  <Email>sample string 10</Email>
  <Fax>sample string 9</Fax>
  <Name>sample string 1</Name>
  <PostCode>sample string 6</PostCode>
  <Telephone>sample string 8</Telephone>
</ClientSite>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the created client site.

ClientSiteViewModel

Name	Description	Type	Additional information
Name	The client sitename.	string	None.
AddressLine1	The client site address line 1.	string	None.
AddressLine2	The client site address line 2.	string	None.
AddressLine3	The client site address line 3.	string	None.
AddressLine4	The client site address line 4.	string	None.
PostCode	The client site postcode.	string	None.
Country	The client site country.	string	None.
Telephone	The client site telephone number.	string	None.
Fax	The client site fax number.	string	None.
Email	The client site email address.	string	None.
Client	The client.	ClientViewModel	None.
ClientSiteGuid	The unique guid for the client site	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

Sample:

{
  "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": "sample string 7",
  "Telephone": "sample string 8",
  "Fax": "sample string 9",
  "Email": "sample string 10",
  "Client": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "AddressLine3": "sample string 3",
    "AddressLine4": "sample string 4",
    "Name": "sample string 5",
    "PostCode": "sample string 6",
    "Country": {
      "Iso3Code": "sample string 1",
      "Name": "sample string 2",
      "Portal": {
        "Name": "sample string 1",
        "Uid": "87882f4d-224d-4c28-98e1-94259f24e6d7",
        "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:55:37.2059411+00:00",
        "UpdatedBy": "sample string 3"
      },
      "CountryGuid": "070e9c9a-31e5-4daa-bb6a-1c0e519e6118",
      "Uid": "f4e40348-5465-446a-926a-f34890664e24",
      "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:55:37.2059411+00:00",
      "UpdatedBy": "sample string 5"
    },
    "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": "87882f4d-224d-4c28-98e1-94259f24e6d7",
          "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:55:37.2059411+00:00",
          "UpdatedBy": "sample string 3"
        },
        "CountryGuid": "070e9c9a-31e5-4daa-bb6a-1c0e519e6118",
        "Uid": "f4e40348-5465-446a-926a-f34890664e24",
        "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:55:37.2059411+00:00",
        "UpdatedBy": "sample string 5"
      },
      "Latitude": "sample string 7",
      "Longitude": "sample string 8",
      "PortalUid": "1104cac7-72e9-472e-9ccb-e6857044c1f1",
      "PortalGuid": "60c945e0-6d1b-480b-8e95-0ceb3ef6586d",
      "CompanyGuid": "652d4437-dbf7-44e9-962e-59d2e2d9d200",
      "Uid": "a45317e5-c55c-4579-a9d9-52b0f547d022",
      "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:55:37.2059411+00:00",
      "UpdatedBy": "sample string 13"
    },
    "ReferenceNumber": "sample string 7",
    "TimesheetNotificationAddress": "sample string 8",
    "ClientGuid": "ca0bb270-0101-459b-9dac-bd08e93f79bc",
    "Uid": "21387ae7-cc4f-4fcb-9bc1-9fa6bd3b3839",
    "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:55:37.2059411+00:00",
    "UpdatedBy": "sample string 11"
  },
  "ClientSiteGuid": "1970df77-36b0-403c-8748-a3931c070a8a",
  "Uid": "5a195cc8-e5ec-4663-bb30-a80654ec5ddb",
  "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:55:37.2059411+00:00",
  "UpdatedBy": "sample string 13"
}

application/xml, text/xml

Sample:

<ClientSiteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T13:55:37.2059411+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>5a195cc8-e5ec-4663-bb30-a80654ec5ddb</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>
  <Client>
    <DateUpdated>2025-10-27T13:55:37.2059411+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>21387ae7-cc4f-4fcb-9bc1-9fa6bd3b3839</Uid>
    <UpdatedBy>sample string 11</UpdatedBy>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <AddressLine3>sample string 3</AddressLine3>
    <AddressLine4>sample string 4</AddressLine4>
    <ClientGuid>ca0bb270-0101-459b-9dac-bd08e93f79bc</ClientGuid>
    <Company>
      <DateUpdated>2025-10-27T13:55:37.2059411+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>a45317e5-c55c-4579-a9d9-52b0f547d022</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>652d4437-dbf7-44e9-962e-59d2e2d9d200</CompanyGuid>
      <Country>
        <DateUpdated>2025-10-27T13:55:37.2059411+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>f4e40348-5465-446a-926a-f34890664e24</Uid>
        <UpdatedBy>sample string 5</UpdatedBy>
        <CountryGuid>070e9c9a-31e5-4daa-bb6a-1c0e519e6118</CountryGuid>
        <Iso3Code>sample string 1</Iso3Code>
        <Name>sample string 2</Name>
        <Portal>
          <DateUpdated>2025-10-27T13:55:37.2059411+00:00</DateUpdated>
          <Links xmlns:d6p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
            <d6p1:Link>
              <d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
              <d6p1:Method>sample string 2</d6p1:Method>
              <d6p1:Rel>sample string 3</d6p1:Rel>
              <d6p1:Title>sample string 4</d6p1:Title>
              <d6p1:Type>sample string 5</d6p1:Type>
            </d6p1:Link>
            <d6p1:Link>
              <d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
              <d6p1:Method>sample string 2</d6p1:Method>
              <d6p1:Rel>sample string 3</d6p1:Rel>
              <d6p1:Title>sample string 4</d6p1:Title>
              <d6p1:Type>sample string 5</d6p1:Type>
            </d6p1:Link>
          </Links>
          <Uid>87882f4d-224d-4c28-98e1-94259f24e6d7</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>60c945e0-6d1b-480b-8e95-0ceb3ef6586d</PortalGuid>
      <PortalUid>1104cac7-72e9-472e-9ccb-e6857044c1f1</PortalUid>
      <PostCode>sample string 6</PostCode>
    </Company>
    <Country>
      <DateUpdated>2025-10-27T13:55:37.2059411+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>f4e40348-5465-446a-926a-f34890664e24</Uid>
      <UpdatedBy>sample string 5</UpdatedBy>
      <CountryGuid>070e9c9a-31e5-4daa-bb6a-1c0e519e6118</CountryGuid>
      <Iso3Code>sample string 1</Iso3Code>
      <Name>sample string 2</Name>
      <Portal>
        <DateUpdated>2025-10-27T13:55:37.2059411+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>87882f4d-224d-4c28-98e1-94259f24e6d7</Uid>
        <UpdatedBy>sample string 3</UpdatedBy>
        <Name>sample string 1</Name>
      </Portal>
    </Country>
    <Name>sample string 5</Name>
    <PostCode>sample string 6</PostCode>
    <ReferenceNumber>sample string 7</ReferenceNumber>
    <TimesheetNotificationAddress>sample string 8</TimesheetNotificationAddress>
  </Client>
  <ClientSiteGuid>1970df77-36b0-403c-8748-a3931c070a8a</ClientSiteGuid>
  <Country>sample string 7</Country>
  <Email>sample string 10</Email>
  <Fax>sample string 9</Fax>
  <Name>sample string 1</Name>
  <PostCode>sample string 6</PostCode>
  <Telephone>sample string 8</Telephone>
</ClientSiteViewModel>