POST api/client/update-client

Request Information

URI Parameters

None.

Body Parameters

SaveClientRequest
NameDescriptionTypeAdditional information
ClientName

string

None.

Comments

string

None.

Address1

string

None.

Address2

string

None.

Address3

string

None.

County

string

None.

Town

string

None.

Postcode

string

None.

Email

string

None.

Telephone

string

None.

Mobile

string

None.

Fax

string

None.

FirstName

string

None.

Surname

string

None.

TradingAs

string

None.

ExternalRef

string

None.

RegistrationNo

string

None.

BusinessTypeID

integer

None.

BusinessType

string

None.

BusinessTypeOther

string

None.

BusinessStatusID

integer

None.

BusinessPartnerCode

string

None.

BrokerCode

string

None.

IntroBrokerCode

string

None.

WorkingCode

string

None.

PositionID

integer

None.

Title

string

None.

CorporateClient

boolean

None.

CCLExemptionPerc

decimal number

None.

UserID

integer

None.

ClientID

integer

None.

TitleID

integer

None.

TitleName

string

None.

BusinessStatus

string

None.

Position

string

None.

FkStageID

integer

None.

IsFinalSubmit

boolean

None.

NumEmployees

boolean

None.

MicroTurnover

boolean

None.

MicroElecticity

boolean

None.

MicroGas

boolean

None.

SmallEmployees

boolean

None.

SmallTurnover

boolean

None.

SmallElecticity

boolean

None.

SmallGas

boolean

None.

LargeEmployees

boolean

None.

LargeTurnover

boolean

None.

LargeElecticity

boolean

None.

LargeGas

boolean

None.

CreatedDate

date

None.

UpdatedDate

date

None.

AllocatedUserID

integer

None.

CampaignCode

string

None.

ClientStatusID

integer

None.

AutoTerminate

boolean

None.

BusinessPartner

string

None.

AllocatedUser

string

None.

ContactID

integer

None.

SiteID

integer

None.

UserTypeID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientName": "sample string 1",
  "Comments": "sample string 2",
  "Address1": "sample string 3",
  "Address2": "sample string 4",
  "Address3": "sample string 5",
  "County": "sample string 6",
  "Town": "sample string 7",
  "Postcode": "sample string 8",
  "Email": "sample string 9",
  "Telephone": "sample string 10",
  "Mobile": "sample string 11",
  "Fax": "sample string 12",
  "FirstName": "sample string 13",
  "Surname": "sample string 14",
  "TradingAs": "sample string 15",
  "ExternalRef": "sample string 16",
  "RegistrationNo": "sample string 17",
  "BusinessTypeID": 18,
  "BusinessType": "sample string 19",
  "BusinessTypeOther": "sample string 20",
  "BusinessStatusID": 21,
  "BusinessPartnerCode": "sample string 22",
  "BrokerCode": "sample string 23",
  "IntroBrokerCode": "sample string 24",
  "WorkingCode": "sample string 25",
  "PositionID": 26,
  "Title": "sample string 27",
  "CorporateClient": true,
  "CCLExemptionPerc": 29.1,
  "UserID": 30,
  "ClientID": 31,
  "TitleID": 32,
  "TitleName": "sample string 33",
  "BusinessStatus": "sample string 34",
  "Position": "sample string 35",
  "FkStageID": 36,
  "IsFinalSubmit": true,
  "NumEmployees": true,
  "MicroTurnover": true,
  "MicroElecticity": true,
  "MicroGas": true,
  "SmallEmployees": true,
  "SmallTurnover": true,
  "SmallElecticity": true,
  "SmallGas": true,
  "LargeEmployees": true,
  "LargeTurnover": true,
  "LargeElecticity": true,
  "LargeGas": true,
  "CreatedDate": "2026-08-14T17:35:58.0132927+01:00",
  "UpdatedDate": "2026-08-14T17:35:58.0132927+01:00",
  "AllocatedUserID": 50,
  "CampaignCode": "sample string 51",
  "ClientStatusID": 52,
  "AutoTerminate": true,
  "BusinessPartner": "sample string 54",
  "AllocatedUser": "sample string 55",
  "ContactID": 56,
  "SiteID": 57,
  "UserTypeID": "sample string 58"
}

application/xml, text/xml

Sample:
<SaveClientRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PricingWebAPI.Models">
  <Address1>sample string 3</Address1>
  <Address2>sample string 4</Address2>
  <Address3>sample string 5</Address3>
  <AllocatedUser>sample string 55</AllocatedUser>
  <AllocatedUserID>50</AllocatedUserID>
  <AutoTerminate>true</AutoTerminate>
  <BrokerCode>sample string 23</BrokerCode>
  <BusinessPartner>sample string 54</BusinessPartner>
  <BusinessPartnerCode>sample string 22</BusinessPartnerCode>
  <BusinessStatus>sample string 34</BusinessStatus>
  <BusinessStatusID>21</BusinessStatusID>
  <BusinessType>sample string 19</BusinessType>
  <BusinessTypeID>18</BusinessTypeID>
  <BusinessTypeOther>sample string 20</BusinessTypeOther>
  <CCLExemptionPerc>29.1</CCLExemptionPerc>
  <CampaignCode>sample string 51</CampaignCode>
  <ClientID>31</ClientID>
  <ClientName>sample string 1</ClientName>
  <ClientStatusID>52</ClientStatusID>
  <Comments>sample string 2</Comments>
  <ContactID>56</ContactID>
  <CorporateClient>true</CorporateClient>
  <County>sample string 6</County>
  <CreatedDate>2026-08-14T17:35:58.0132927+01:00</CreatedDate>
  <Email>sample string 9</Email>
  <ExternalRef>sample string 16</ExternalRef>
  <Fax>sample string 12</Fax>
  <FirstName>sample string 13</FirstName>
  <FkStageID>36</FkStageID>
  <IntroBrokerCode>sample string 24</IntroBrokerCode>
  <IsFinalSubmit>true</IsFinalSubmit>
  <LargeElecticity>true</LargeElecticity>
  <LargeEmployees>true</LargeEmployees>
  <LargeGas>true</LargeGas>
  <LargeTurnover>true</LargeTurnover>
  <MicroElecticity>true</MicroElecticity>
  <MicroGas>true</MicroGas>
  <MicroTurnover>true</MicroTurnover>
  <Mobile>sample string 11</Mobile>
  <NumEmployees>true</NumEmployees>
  <Position>sample string 35</Position>
  <PositionID>26</PositionID>
  <Postcode>sample string 8</Postcode>
  <RegistrationNo>sample string 17</RegistrationNo>
  <SiteID>57</SiteID>
  <SmallElecticity>true</SmallElecticity>
  <SmallEmployees>true</SmallEmployees>
  <SmallGas>true</SmallGas>
  <SmallTurnover>true</SmallTurnover>
  <Surname>sample string 14</Surname>
  <Telephone>sample string 10</Telephone>
  <Title>sample string 27</Title>
  <TitleID>32</TitleID>
  <TitleName>sample string 33</TitleName>
  <Town>sample string 7</Town>
  <TradingAs>sample string 15</TradingAs>
  <UpdatedDate>2026-08-14T17:35:58.0132927+01:00</UpdatedDate>
  <UserID>30</UserID>
  <UserTypeID>sample string 58</UserTypeID>
  <WorkingCode>sample string 25</WorkingCode>
</SaveClientRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.