Update Contact
Use this operation to update any of the writable fields of an existing Contact object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL.
Parameters
Body Params | |
---|---|
JSON: | json |
XML: | string |
Path Params | |
---|---|
yourCompany: | string |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Contact Object
{
"Contacts": {
"Contact": [{
"Salutation": "--None--",
"FirstName": "Test",
"LastName": "New Contact",
"OfficePhone": "56412356",
"Mobile": "7412536589",
"HomePhone": "56412356",
"OtherPhone": "",
"Fax": "5689746",
"AccountName": "Account1",
"AccountID": "234",
"VendorName": "Vendor1",
"VendorID": "30",
"ContactType": "Competitor",
"Title": "Test Title",
"Department": "Test Department",
"Email": "[email protected]",
"ReportsTo": "",
"ReportsToID": "",
"Assistant": "",
"YahooID": "[email protected]",
"AssistantPhone": "5989654",
"DoNotCall": "No",
"EmailOptOut": "No",
"AssignedToUser": "Administrator",
"LeadSource": "Self Generated",
"Birthday": "01-21-2020",
"ContactProfile": "Buyer",
"MailingStreet": "1515 Clay Street",
"MailingCity": "Oakland",
"MailingState": "CA",
"MailingZip": "94624",
"MailingCountry": "United States",
"OtherStreet": "1515 Clay Street",
"OtherCity": "Oakland",
"OtherState": "CA",
"OtherZip": "94624",
"OtherCountry": "United States",
"CreatedTime": "01-24-2020 05:32:01",
"ModifiedTime": "01-24-2020 05:32:01",
"Description": "The Description Goes here.",
"B2BCustomer": "Yes",
"B2BChannels": "Ebay",
"CustomFields": {
"CustomField": [{
"Name": "CustomFied1",
"Value": "Custom info 1"
},
{
"Name": "CustomFied2",
"Value": "Custom info 2"
}
]
}
}]
}
}
<Contacts>
<Contact>
<ContactId>156908</ContactId>
<Salutation>--None--</Salutation>
<FirstName>Test</FirstName>
<LastName>New Contact</LastName>
<OfficePhone>56412356</OfficePhone>
<Mobile>7412536589</Mobile>
<HomePhone>56412356</HomePhone>
<OtherPhone></OtherPhone>
<Fax>5689746</Fax>
<AccountName>Account1</AccountName>
<AccountID>234</AccountID>
<VendorName>Vendor1</VendorName>
<VendorID>30</VendorID>
<ContactType>Competitor</ContactType>
<Title>Test Title</Title>
<Department>Test Department</Department>
<Email>[email protected]</Email>
<ReportsTo></ReportsTo>
<ReportsToID></ReportsToID>
<Assistant></Assistant>
<YahooID>[email protected]</YahooID>
<AssistantPhone>5989654</AssistantPhone>
<DoNotCall>No</DoNotCall>
<EmailOptOut>No</EmailOptOut>
<AssignedToUser> Administrator</AssignedToUser>
<LeadSource>Self Generated</LeadSource>
<Birthday>01-21-2020</Birthday>
<ContactProfile>Buyer</ContactProfile>
<MailingStreet>1515 Clay Street</MailingStreet>
<MailingCity>Oakland</MailingCity>
<MailingState>CA</MailingState>
<MailingZip>94624</MailingZip>
<MailingCountry>United States</MailingCountry>
<OtherStreet>1515 Clay Street</OtherStreet>
<OtherCity>Oakland</OtherCity>
<OtherState>CA</OtherState>
<OtherZip>94624</OtherZip>
<OtherCountry>United States</OtherCountry>
<CreatedTime>01-24-2020 05:32:01</CreatedTime>
<ModifiedTime>01-24-2020 05:32:01</ModifiedTime>
<Description>The Description Goes here.</Description>
<B2BCustomer>Yes</B2BCustomer>
<B2BChannels>Ebay</B2BChannels>
<CustomFields>
<CustomField>
<Name>CustomFied1</Name>
<Value>Custom info 1</Value>
</CustomField>
<CustomField>
<Name>CustomFied2</Name>
<Value>Custom info 2</Value>
</CustomField>
</CustomFields>
</Contact>
</Contacts>
Sample Response
{
"MCM": {
"response": {
"objectType": "Contact",
"syncTime": "2021-06-10 03:23:14"
},
"parameters": {
"results": {
"message": {
"status": "Success",
"success_message": {
"contact_name": "Test New Contact",
"contact_id": "203060"
}
}
}
}
}
}
<MCM>
<response>
<objectType>Contact</objectType>
<syncTime>2021-06-10 03:23:14</syncTime>
</response>
<parameters>
<results>
<message>
<status>Success</status>
<success_message>
<contact_name>Test New Contact</contact_name>
<contact_id>203060</contact_id>
</success_message>
</message>
</results>
</parameters>
</MCM>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Contact">
<method name="PUT">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="ContactId" type="xsd:int" style="body" required="true"/>
<param name="Salutation" type="xsd:string" style="body"/>
<param name="FirstName" type="xsd:string" style="body" required="true"/>
<param name="LastName" type="xsd:string" style="body" required="true"/>
<param name="OfficePhone" type="xsd:string" style="body"/>
<param name="Mobile" type="xsd:string" style="body"/>
<param name="HomePhone" type="xsd:string" style="body"/>
<param name="OtherPhone" type="xsd:string" style="body"/>
<param name="Fax" type="xsd:string" style="body"/>
<param name="AccountName" type="xsd:string" style="body"/>
<param name="AccountID" type="xsd:int" style="body"/>
<param name="VendorName" type="xsd:string" style="body"/>
<param name="VendorID" type="xsd:string" style="body"/>
<param name="ContactType" type="xsd:string" style="body"/>
<param name="Title" type="xsd:string" style="body"/>
<param name="Department" type="xsd:int" style="body"/>
<param name="Email" type="xsd:string" style="body"/>
<param name="ReportsTo" type="xsd:int" style="body"/>
<param name="ReportsToID" type="xsd:string" style="body"/>
<param name="Assistant" type="xsd:string" style="body"/>
<param name="YahooID" type="xsd:string" style="body"/>
<param name="AssistantPhone" type="xsd:string" style="body"/>
<param name="DoNotCall" type="xsd:string" style="body"/>
<param name="EmailOptOut" type="xsd:string" style="body"/>
<param name="AssignedToUser" type="xsd:string" style="body"/>
<param name="LeadSource" type="xsd:string" style="body"/>
<param name="Birthday" type="xsd:date" style="body"/>
<param name="ContactProfile" type="xsd:string" style="body"/>
<param name="MailingStreet" type="xsd:string" style="body"/>
<param name="MailingCity" type="xsd:string" style="body"/>
<param name="MailingState" type="xsd:string" style="body"/>
<param name="MailingZip" type="xsd:string" style="body"/>
<param name="MailingCountry" type="xsd:string" style="body"/>
<param name="OtherStreet" type="xsd:string" style="body"/>
<param name="OtherCity" type="xsd:string" style="body"/>
<param name="OtherState" type="xsd:string" style="body"/>
<param name="OtherZip" type="xsd:string" style="body"/>
<param name="OtherCountry" type="xsd:string" style="body"/>
<param name="CreatedTime" type="xsd:dateTime" style="body"/>
<param name="ModifiedTime" type="xsd:dateTime" style="body"/>
<param name="Description" type="xsd:string" style="body"/>
<param name="B2BCustomer" type="xsd:string" style="body"/>
<param name="B2BChannels" type="xsd:string" style="body"/>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet"/>
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error"/>
</response>
</method>
</resource>
</resources>
</application>
Updated about 21 hours ago