POST https://api.d-tools.com/SI/Publish/Clients/Update

Update an existing client in SI

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
IntegrationId	Integration Id of client to update (Must pass either IntegrationId Or Client Number)	string	None.
Number	Number of client to update (Must pass either IntegrationId Or Client Number)	string	None.
UpdateFields	List of UpdateFields for the client. Each UpdateField has a Id and a Value.	Collection of UpdateClientField	None.
SiteAddress	Client Site Address	Address	None.
BillingAddress	Client Billing Address	Address	None.

Request Formats

application/json, text/json

Sample:

{
  "IntegrationId": "sample string 1",
  "Number": "sample string 2",
  "UpdateFields": [
    {
      "ClientFieldId": 64,
      "Value": "sample string 2"
    },
    {
      "ClientFieldId": 64,
      "Value": "sample string 2"
    }
  ],
  "SiteAddress": {
    "Street1": "sample string 1",
    "Street2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "PostalCode": "sample string 5",
    "Country": "sample string 6",
    "Phone": "sample string 7",
    "Fax": "sample string 8"
  },
  "BillingAddress": {
    "Street1": "sample string 1",
    "Street2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "PostalCode": "sample string 5",
    "Country": "sample string 6",
    "Phone": "sample string 7",
    "Fax": "sample string 8"
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateClient'.

application/xml, text/xml

Sample:

<UpdateClient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IntegrationId>sample string 1</IntegrationId>
  <Number>sample string 2</Number>
  <UpdateFields>
    <UpdateClientField>
      <ClientFieldId>64</ClientFieldId>
      <Value>sample string 2</Value>
    </UpdateClientField>
    <UpdateClientField>
      <ClientFieldId>64</ClientFieldId>
      <Value>sample string 2</Value>
    </UpdateClientField>
  </UpdateFields>
  <SiteAddress>
    <Street1>sample string 1</Street1>
    <Street2>sample string 2</Street2>
    <City>sample string 3</City>
    <State>sample string 4</State>
    <PostalCode>sample string 5</PostalCode>
    <Country>sample string 6</Country>
    <Phone>sample string 7</Phone>
    <Fax>sample string 8</Fax>
  </SiteAddress>
  <BillingAddress>
    <Street1>sample string 1</Street1>
    <Street2>sample string 2</Street2>
    <City>sample string 3</City>
    <State>sample string 4</State>
    <PostalCode>sample string 5</PostalCode>
    <Country>sample string 6</Country>
    <Phone>sample string 7</Phone>
    <Fax>sample string 8</Fax>
  </BillingAddress>
</UpdateClient>

Response Information

Resource Description

PublishResponse

Name	Description	Type	Additional information
MessageId	Check the status of the transaction using this Message Id	globally unique identifier	None.
Message	Success Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "MessageId": "58e20fb3-2d6c-494b-a459-f8ca7b1edd7b",
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<PublishResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MessageId>58e20fb3-2d6c-494b-a459-f8ca7b1edd7b</MessageId>
  <Message>sample string 2</Message>
</PublishResponse>