Purpose:
This method used to update the customer information.
Request URL:
https://api.apptivo.com/app/dao/v6/customers?a=update&customerData={CUSTOMER_DATA_VALUES}&attributeNames=[CUSTOMER_DATA_NAME]&objectId=4&customerId=CUSTOMER_ID&isEmailAddressUpdate=EMAIL_UPDATE&apiKey=API_KEY&accessKey=ACCESS_KEY
Update customer by Customer Name
Request Parameters:
| Parameter | Description |
| BaseURL | https://api.apptivo.com/app/dao/v6/customers |
| a | action |
| customerData* | Please see the sample request URL |
| customerId | Customer id which presents in the Apptivo system for the particular customer we want to update |
| attributeName | [“customerName”] attribute name which we want to update. |
| attributeIds | The id of the attribute(which present in Apptivo) |
| apiKey* | Apptivo API Key |
| accessKey* | Apptivo Access Key |
* – Mandatory parameters
Output:
This will return the details of updated customer data with JSON format.
Sample Request API URL:
https://api.apptivo.com/app/dao/v6/customers?a=update&customerData={"customAttributes":[{"customAttributeId":"input_1528893649501_367_1127461528893649501_704","customAttributeName":"input_1528893649501_117_839291528893649501_645","customAttributeValue":"","attributeValues":[],"customAttributeType":"input","fieldType":"NUMBER","t":"Y","customAttributeTagName":"input_1528893649501_117_839291528893649501_645","undefined":"","input_1528893649501_117_839291528893649501_645":""},{"customAttributeId":"input_1530531982205_792_1049571530531982205_275","customAttributeName":"input_1530531982205_532_982921530531982205_335","customAttributeValue":"","attributeValues":[],"customAttributeType":"input","fieldType":"NUMBER","t":"Y","customAttributeTagName":"input_1530531982205_532_982921530531982205_335","undefined":"","input_1530531982205_532_982921530531982205_335":""},{"customAttributeId":"select_1528893649502_389_820021528893649502_920","customAttributeName":"select_1528893649502_583_987801528893649502_923","attributeValues":[],"customAttributeType":"select","fieldType":"NUMBER","t":"Y","customAttributeTagName":"select_1528893649502_583_987801528893649502_923"}],"customerId":1224395,"customerName":"Apptivo, Inc.","customerNumber":"60","customerCategory":"","customerCategoryId":null,"statusName":"Active","statusId":10000,"defaultBillingCurrency":"USD","assigneeObjectRefName":"sites user","assigneeObjectRefId":76886,"assigneeObjectId":8,"description":"","phoneNumber":"","contactEmail":"","skypeName":"","parentCustomerName":"","parentCustomerId":null,"employeeRange":"","employeeRangeId":null,"website":"","tickerSymbol":"","annualRevenue":null,"annualRevenueCurrencyCode":"USD","campaignName":"","campaignId":null,"creditRating":"","marketName":"","marketId":null,"segmentName":"","segmentId":null,"industryName":"","industryId":null,"paymentTerm":"Net 30","paymentTermId":98234,"ownership":"","slaName":"","slaId":null,"isUnsubscribed":"N","removeLabels":[],"accounts":[],"territories":[],"isBounced":"N","bouncedReason":null,"isResponded":"N","syncToGoogle":"N","followUpDate":null,"followUpDescription":null,"createdByName":"sites user","lastUpdatedByName":"sites user","creationDate":"2018-08-28 06:38:34","lastUpdateDate":"2018-08-28 06:38:34","isExistingCustomer":"Y","isAffiliate":"Y","faceBookURL":"","twitterURL":"","linkedInURL":"","createdBy":75746,"lastUpdatedBy":null,"labels":[],"phoneNumbers":[{"phoneNumber":"5555555555","phoneType":"Business","phoneTypeCode":"PHONE_BUSINESS","id":"cust_phone_input","communicationId":1}],"removePhoneNumbers":[],"emailAddresses":[{"emailAddress":"ABC@berijam.com","emailTypeCode":"BUSINESS","emailType":"Business","id":"cont_email_input","communicationId":1}],"addresses":[{"id":"address_section_attr_id_f6dd7f7c-0add-4fef-aeea-5bd3541718af","addressId":15243737,"accountAddressId":1117581,"addressAttributeId":"address_section_attr_id","addressType":"Billing Address","addressTypeCode":"1","addressLine1":"22","addressLine2":"1","city":"texas","state":"Alaska","stateCode":"AK","countryId":176,"countryName":"United States","countryCode":"US","zipCode":"43545","addressGroupName":"Address1","isAdded":false}],"affiliateLogoId":null}&customerId=1224395&attributeName=["customerName"]&attributeIds=["cust_name_attr"]&apiKey=ZMQYFZTzBXAW-DoPSURDtNVBUEY-518d51ae-ab26-4c04-9f7b-8d26a586e90e&accessKey=SqQxOzQZDvUT-fTsOrItIVDUGyV-5c90b8a3-4683-4145-8584-1ed40de970b9
Sample Response
{"customer":{"id":"1224395","objectId":3,"customerId":1224395,"customerNumber":"60","customerName":"Apptivo, Inc.","customerNameNotAnalysed":"Apptivo, ….}}
Update customer by address, phone number, email address
Request Parameters:
| Parameter | Description |
| BaseURL | https://api.apptivo.com/app/dao/v6/customers |
| a | action(update) |
| customerData* | Please see the sample request URL |
| customerId | Customer id which presents in the Apptivo system for the particular customer we want to update |
| attributeName | [“phoneNumbers”,”emailAddresses”,”address”] attribute name which we want to update. |
| attributeIds | The id of the attribute(which present in Apptivo)Ex: [“cust_phone_attr”,”email_attr”,null] |
| isAddressUpdate | If we going to update address need to pass this param as “true” |
| isPhoneNumberUpdate | If we going to update phone number need to pass this param as “true” |
| isEmailAddressUpdate | If we going to update email address need to pass this param as “true” |
| apiKey* | Apptivo API Key |
| accessKey* | Apptivo Access Key |
* – Mandatory parameters
Output:
This will return the details of updated customer data with JSON format.
Sample Request API URL:
https://api.apptivo.com/app/dao/v6/customers?a=update&customerData={"customAttributes":[],"customerId":1333795,"customerName":"TestCustomer","customerNumber":"103","customerCategory":"","customerCategoryId":null,"statusName":"Active","statusId":10000,"defaultBillingCurrency":"INR","assigneeObjectRefName":"Db2Es s","assigneeObjectRefId":77021,"assigneeObjectId":8,"description":"","phoneNumber":"","contactEmail":"","skypeName":"","parentCustomerName":"","parentCustomerId":null,"employeeRange":"","employeeRangeId":null,"website":"","tickerSymbol":"","annualRevenue":null,"annualRevenueCurrencyCode":"USD","campaignName":"","campaignId":null,"creditRating":"","marketName":"","marketId":null,"segmentName":"","segmentId":null,"industryName":"","industryId":null,"paymentTerm":"Net 30","paymentTermId":98763,"ownership":"","slaName":"","slaId":null,"isUnsubscribed":"N","removeLabels":[],"accounts":[],"territories":[],"isBounced":"N","bouncedReason":null,"isResponded":"N","syncToGoogle":"N","supportPlanName":"","supportPlanId":null,"followUpDate":null,"followUpDescription":null,"createdByName":"sites user","lastUpdatedByName":"sites user","creationDate":"2019-01-07 12:54:00","lastUpdateDate":"2019-01-10 02:38:19","isExistingCustomer":"N","isAffiliate":"Y","faceBookURL":"","twitterURL":"","linkedInURL":"","createdBy":75746,"lastUpdatedBy":null,"labels":[],"phoneNumbers":[{"phoneNumber":"5555554424","phoneType":"Business","phoneTypeCode":"PHONE_BUSINESS","id":"cust_phone_input","communicationId":1}],"removePhoneNumbers":[],"emailAddresses":[{"emailAddress":"apptivoTest2@berijam.com","emailTypeCode":"BUSINESS","emailType":"Business","id":"cont_email_input","communicationId":1}],"removeEmailAddresses":[{"emailAddress":"apptivoTest1@berijam.com","emailTypeCode":"BUSINESS","emailType":"Business","id":"cont_email_input","communicationId":1}],"addresses":[{"id":"address_section_attr_id_2e46a748-20ff-47d0-95ef-8a1ee37bb93b","addressId":22998677,"accountAddressId":1251158,"addressAttributeId":"address_section_attr_id","addressType":"Billing Address","addressTypeCode":"1","addressLine1":"22","addressLine2":"ss street","city":"texas","county":"","state":"Arizona","stateCode":"AZ","countryId":176,"countryName":"United States","countryCode":"US","zipCode":"55566","addressGroupName":"Address1","isAdded":false}],"affiliateLogoId":null}&customerId=1333795&attributeName=["phoneNumbers","emailAddresses","address"]&attributeIds=["cust_phone_attr","email_attr",null]&isAddressUpdate=true&isPhoneNumberUpdate=true&isEmailAddressUpdate=true&apiKey=ZMQYFZTzBXAW-DoPSURDtNVBUEY-518d51ae-ab26-4c04-9f7b-8d26a586e90e&accessKey=SqQxOzQZDvUT-fTsOrItIVDUGyV-5c90b8a3-4683-4145-8584-1ed40de970b9
Sample Response
{"customer":{"id":"1333795","objectId":3,"customerId":1333795,"customerNumber":"103","customerName":"TestCustomer","customerNameNotAnalysed":"TestCustomer","customerCategory":"","assigneeObjectRefName":"Db2Es s","assigneeObjectRefId":77021,"assigneeObjectId":8,"skypeName":"","description":"","parentCustomerName":"","employeeRange":"","website":"","tickerSymbol":"","campaignName":"","creditRating":"","marketName":"","segmentName":"","industryName":"","paymentTerm":"Net…..}
