PUT api/Contact?APIKey={APIKey}&ClientId={ClientId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
APIKey | string |
Required |
|
ClientId | string |
Required |
Body Parameters
ContactRequestName | Description | Type | Additional information |
---|---|---|---|
Contact | Contact |
None. |
Request Formats
application/json, text/json
Sample:
{ "Contact": { "Id": "96e94ae4-0411-434b-b7d7-cdc723390a97", "Number": "sample string 2", "Prefix": "sample string 3", "FirstName": "sample string 4", "MiddleInitial": "sample string 5", "LastName": "sample string 6", "Suffix": "sample string 7", "JobTitle": "sample string 8", "NickName": "sample string 9", "Gender": "sample string 10", "CustomerType": "sample string 11", "BirthDate": "2024-11-20T06:29:18.7887414+00:00", "Age": 12, "Member": true, "Designation": "sample string 14", "Image": "sample string 15", "IncludeInDirectory": true, "EmailCommunication": true, "Facebook": "sample string 18", "Twitter": "sample string 19", "LinkedIn": "sample string 20", "WebSite": "sample string 21", "PaidThroughDate": "2024-11-20T06:29:18.7887414+00:00", "OriginalJoinDate": "2024-11-20T06:29:18.7887414+00:00", "LabelName": "sample string 22", "Primary_AddressName": "sample string 23", "Primary_Address1": "sample string 24", "Primary_Address2": "sample string 25", "Primary_Address3": "sample string 26", "Primary_City": "sample string 27", "Primary_State": "sample string 28", "Primary_PostalCode": "sample string 29", "Primary_Country": "sample string 30", "Secondary_AddressName": "sample string 31", "Secondary_Address1": "sample string 32", "Secondary_Address2": "sample string 33", "Secondary_Address3": "sample string 34", "Secondary_City": "sample string 35", "Secondary_State": "sample string 36", "Secondary_PostalCode": "sample string 37", "Secondary_Country": "sample string 38", "BusinessPhone": "sample string 39", "HomePhone": "sample string 40", "MobilePhone": "sample string 41", "Fax": "sample string 42", "PriceLevel": "sample string 43", "Email": "sample string 44", "ParentCustomer": { "Type": 1, "Id": "30daf7b5-fe1d-40b3-8ca5-17e892be9cc6", "Number": "sample string 2", "Name": "sample string 3" }, "Custom": { "Attribute": [ { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" }, { "Type": 0, "Key": "sample string 1", "Value": "sample string 2", "FormattedValue": "sample string 3" } ] } } }
application/xml, text/xml
Sample:
<ContactRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Contact"> <Contact> <Age>12</Age> <BirthDate>2024-11-20T06:29:18.7887414+00:00</BirthDate> <BusinessPhone>sample string 39</BusinessPhone> <Custom> <Attribute xmlns:d4p1="http://schemas.datacontract.org/2004/07/Protech.UX.API.CRMEntity"> <d4p1:Attribute> <d4p1:FormattedValue>sample string 3</d4p1:FormattedValue> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Type>text</d4p1:Type> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:Attribute> <d4p1:Attribute> <d4p1:FormattedValue>sample string 3</d4p1:FormattedValue> <d4p1:Key>sample string 1</d4p1:Key> <d4p1:Type>text</d4p1:Type> <d4p1:Value>sample string 2</d4p1:Value> </d4p1:Attribute> </Attribute> </Custom> <CustomerType>sample string 11</CustomerType> <Designation>sample string 14</Designation> <Email>sample string 44</Email> <EmailCommunication>true</EmailCommunication> <Facebook>sample string 18</Facebook> <Fax>sample string 42</Fax> <FirstName>sample string 4</FirstName> <Gender>sample string 10</Gender> <HomePhone>sample string 40</HomePhone> <Id>96e94ae4-0411-434b-b7d7-cdc723390a97</Id> <Image>sample string 15</Image> <IncludeInDirectory>true</IncludeInDirectory> <JobTitle>sample string 8</JobTitle> <LabelName>sample string 22</LabelName> <LastName>sample string 6</LastName> <LinkedIn>sample string 20</LinkedIn> <Member>true</Member> <MiddleInitial>sample string 5</MiddleInitial> <MobilePhone>sample string 41</MobilePhone> <NickName>sample string 9</NickName> <Number>sample string 2</Number> <OriginalJoinDate>2024-11-20T06:29:18.7887414+00:00</OriginalJoinDate> <PaidThroughDate>2024-11-20T06:29:18.7887414+00:00</PaidThroughDate> <ParentCustomer> <Id>30daf7b5-fe1d-40b3-8ca5-17e892be9cc6</Id> <Name>sample string 3</Name> <Number>sample string 2</Number> <Type>account</Type> </ParentCustomer> <Prefix>sample string 3</Prefix> <PriceLevel>sample string 43</PriceLevel> <Primary_Address1>sample string 24</Primary_Address1> <Primary_Address2>sample string 25</Primary_Address2> <Primary_Address3>sample string 26</Primary_Address3> <Primary_AddressName>sample string 23</Primary_AddressName> <Primary_City>sample string 27</Primary_City> <Primary_Country>sample string 30</Primary_Country> <Primary_PostalCode>sample string 29</Primary_PostalCode> <Primary_State>sample string 28</Primary_State> <Secondary_Address1>sample string 32</Secondary_Address1> <Secondary_Address2>sample string 33</Secondary_Address2> <Secondary_Address3>sample string 34</Secondary_Address3> <Secondary_AddressName>sample string 31</Secondary_AddressName> <Secondary_City>sample string 35</Secondary_City> <Secondary_Country>sample string 38</Secondary_Country> <Secondary_PostalCode>sample string 37</Secondary_PostalCode> <Secondary_State>sample string 36</Secondary_State> <Suffix>sample string 7</Suffix> <Twitter>sample string 19</Twitter> <WebSite>sample string 21</WebSite> </Contact> </ContactRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
APIResponseName | Description | Type | Additional information |
---|---|---|---|
Status | Status |
None. |
|
Id | globally unique identifier |
None. |
|
Description | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Status": 0, "Id": "dec7095c-25df-4bd2-9a2d-1cefe201c71a", "Description": "sample string 2" }
application/xml, text/xml
Sample:
<APIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Protech.UX.API.Response"> <Description>sample string 2</Description> <Id>dec7095c-25df-4bd2-9a2d-1cefe201c71a</Id> <Status>Success</Status> </APIResponse>