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

Creates a new client in the customer poral

Request Information

URI Parameters

NameDescriptionTypeAdditional information
portalUid

the portal we are creating the client in

 globally unique identifier

Required

Body Parameters

Client
NameDescriptionTypeAdditional information
AddressLine1

The client address line1.

 string

String length: inclusive between 0 and 100
AddressLine2

The client address line2.

 string

String length: inclusive between 0 and 100
AddressLine3

The client address line3.

 string

String length: inclusive between 0 and 100
AddressLine4

The client address line4.

 string

String length: inclusive between 0 and 100
Name

The client client name.

 string

Required

String length: inclusive between 0 and 100
PostCode

The client post code.

 string

String length: inclusive between 0 and 50
Country

The client country.

 globally unique identifier

None.
Company

The company.

 globally unique identifier

None.
TimesheetNotificationAddress

The default email address to sent timesheet notifications

 string

None.
ReferenceNumber

External reference number

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "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": "b9145e82-f036-471a-926d-cc29b2825bf9",
  "Company": "544dc985-b602-409d-8891-a61884595c1f",
  "TimesheetNotificationAddress": "sample string 9",
  "ReferenceNumber": "sample string 10"
}

application/xml, text/xml

Sample: 
<Client xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <AddressLine1>sample string 1</AddressLine1>
  <AddressLine2>sample string 2</AddressLine2>
  <AddressLine3>sample string 3</AddressLine3>
  <AddressLine4>sample string 4</AddressLine4>
  <Company>544dc985-b602-409d-8891-a61884595c1f</Company>
  <Country>b9145e82-f036-471a-926d-cc29b2825bf9</Country>
  <Name>sample string 5</Name>
  <PostCode>sample string 6</PostCode>
  <ReferenceNumber>sample string 10</ReferenceNumber>
  <TimesheetNotificationAddress>sample string 9</TimesheetNotificationAddress>
</Client>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

the created client

ClientViewModel
NameDescriptionTypeAdditional information
AddressLine1

The address line1.

 string

None.
AddressLine2

The address line2.

 string

None.
AddressLine3

The address line3.

 string

None.
AddressLine4

The address line4.

 string

None.
Name

The client name.

 string

None.
PostCode

The post code.

 string

None.
Country

The country.

 CountryViewModel

None.
Company

The company.

 CompanyViewModel

None.
ReferenceNumber

Client Reference Number.

 string

None.
TimesheetNotificationAddress

The default email address to sent timesheet notifications

 string

None.
ClientGuid

The client unnique identifier

 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: 
{
  "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": "be1b21d2-9e44-4f31-b6f6-faeea9372529",
      "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-12-21T17:52:52.4587858+00:00",
      "UpdatedBy": "sample string 3"
    },
    "CountryGuid": "3c514ee2-cc2c-4aa5-91c0-7a7e7fb3d0be",
    "Uid": "4edc9210-3607-42e9-ac5f-5a49c3a8177f",
    "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-12-21T17:52:52.4587858+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": "be1b21d2-9e44-4f31-b6f6-faeea9372529",
        "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-12-21T17:52:52.4587858+00:00",
        "UpdatedBy": "sample string 3"
      },
      "CountryGuid": "3c514ee2-cc2c-4aa5-91c0-7a7e7fb3d0be",
      "Uid": "4edc9210-3607-42e9-ac5f-5a49c3a8177f",
      "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-12-21T17:52:52.4587858+00:00",
      "UpdatedBy": "sample string 5"
    },
    "Latitude": "sample string 7",
    "Longitude": "sample string 8",
    "PortalUid": "dc032728-f4fc-414e-9ce7-a675d6329955",
    "PortalGuid": "13b3cdcd-971f-46ac-b235-2794ebbbf91f",
    "CompanyGuid": "99b1ab5b-42eb-4387-a743-bd0fe78f31e5",
    "Uid": "a3e93cab-2e45-4e17-8eb9-d8020fb28d95",
    "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-12-21T17:52:52.4587858+00:00",
    "UpdatedBy": "sample string 13"
  },
  "ReferenceNumber": "sample string 7",
  "TimesheetNotificationAddress": "sample string 8",
  "ClientGuid": "7df9fb9c-eaf4-41ed-a883-b9f7d114156a",
  "Uid": "bcd2ae58-0426-47f4-8efd-87f38a212ae0",
  "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-12-21T17:52:52.4587858+00:00",
  "UpdatedBy": "sample string 11"
}

application/xml, text/xml

Sample: 
<ClientViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-12-21T17:52:52.4587858+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>bcd2ae58-0426-47f4-8efd-87f38a212ae0</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>7df9fb9c-eaf4-41ed-a883-b9f7d114156a</ClientGuid>
  <Company>
    <DateUpdated>2025-12-21T17:52:52.4587858+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>a3e93cab-2e45-4e17-8eb9-d8020fb28d95</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>99b1ab5b-42eb-4387-a743-bd0fe78f31e5</CompanyGuid>
    <Country>
      <DateUpdated>2025-12-21T17:52:52.4587858+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>4edc9210-3607-42e9-ac5f-5a49c3a8177f</Uid>
      <UpdatedBy>sample string 5</UpdatedBy>
      <CountryGuid>3c514ee2-cc2c-4aa5-91c0-7a7e7fb3d0be</CountryGuid>
      <Iso3Code>sample string 1</Iso3Code>
      <Name>sample string 2</Name>
      <Portal>
        <DateUpdated>2025-12-21T17:52:52.4587858+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>be1b21d2-9e44-4f31-b6f6-faeea9372529</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>13b3cdcd-971f-46ac-b235-2794ebbbf91f</PortalGuid>
    <PortalUid>dc032728-f4fc-414e-9ce7-a675d6329955</PortalUid>
    <PostCode>sample string 6</PostCode>
  </Company>
  <Country>
    <DateUpdated>2025-12-21T17:52:52.4587858+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>4edc9210-3607-42e9-ac5f-5a49c3a8177f</Uid>
    <UpdatedBy>sample string 5</UpdatedBy>
    <CountryGuid>3c514ee2-cc2c-4aa5-91c0-7a7e7fb3d0be</CountryGuid>
    <Iso3Code>sample string 1</Iso3Code>
    <Name>sample string 2</Name>
    <Portal>
      <DateUpdated>2025-12-21T17:52:52.4587858+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>be1b21d2-9e44-4f31-b6f6-faeea9372529</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>
</ClientViewModel>