Customers API Reference

Customers API Reference

The purpose of Customer API is to:

• Explain how customer records can be created
• Example responses for different operations
• List of API methods for customers

API methods for Customers as follows:

• Get all customers
• Create customers
• Search a customer
• Update a customer
• Delete a customer

Web Method: getCustomersConfigData

Purpose

You can use the getConfigData method to get all the configuration data’s like customer types, market, category and etc.

Request API URL

https://api.apptivo.com/app/dao/v6/customers?a=getConfigData&apiKey=API_KEY&accessKey=ACCESS_KEY

Request Parameters

Parameter	Data Type	Description
apiKey*	String	Apptivo business account API Key
accessKey*	String	Apptivo business account Access Key

* – Mandatory parameters

Output

This will return all the customer configuration data with JSON format.

Notes

• You can get these configuration values and use them while creating customers.

Sample URL

https://api.apptivo.com/app/dao/v6/customers?a=getConfigData&apiKey=oRxYzRZRvOTH-cTPBPVPArJnVNW-6a8d8bf4-1c5f-4930-a5da-49f380afcd33&accessKey=3g806jxv5gq7Q62E

Web Method: createCustomer

Purpose:

You can use createCustomer method to create customers in Apptivo with generic fields provided by application.

Request URL:

https://api.apptivo.com/app/dao/v6/customers?a=save&customerData{ CUSTOMER_DATA}&apiKey=API_KEY&accesKey=ACCESS_KEY

Request Parameters:

Parameter	Data Type	Description
customerData*	JSON	Please see the sample request URL
apiKey*	String	Apptivo API Key
accessKey*	String	Apptivo Access Key

* – Mandatory parameters

Output:

This will return the details of the created customer with JSON format.

Sample Request URL:

https://www.apptivo.com/app/dao/v6/customers?a=save&customerData={"customAttributes":[],"customerId":null,"customerName":"TestCustomer","customerNumber":"Auto generated number","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":"INR","campaignName":"","campaignId":null,"creditRating":"","marketName":"","marketId":null,"segmentName":"","segmentId":null,"industryName":"","industryId":null,"paymentTerm":"Net 30","paymentTermId":98763,"ownership":"","slaName":"","slaId":null,"isUnsubscribed":"N","accounts":[],"territories":[],"isBounced":"N","bouncedReason":null,"isResponded":"N","followUpDate":null,"followUpDescription":null,"createdByName":"","lastUpdatedByName":"","creationDate":"","lastUpdateDate":"","isExistingCustomer":"N","isAffiliate":"N","faceBookURL":"","twitterURL":"","linkedInURL":"","createdBy":null,"lastUpdatedBy":null,"labels":[],"addresses":[{"addressAttributeId":"address_section_attr_id","addressTypeCode":"1","addressType":"Billing Address","addressLine1":"","addressLine2":"","city":"","stateCode":"","addressGroupName":"Address1","state":"","zipCode":"","countryId":70,"countryName":"India","countryCode":"IN","deliveryInstructions":null,"county":null}],"lastContactedDate":null}
&isLeadConvert=N
&isDuplicate=false

 

 

Web Method: updateCustomer

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&accesKey=ACCESS_KEY

Request Parameters:

Parameter	Data Type	Description
CUSTOMER_ID	Customer ID
CUSTOMER_DATA_VALUES	Updated field value
CUSTOMER_DATA_NAME	Updated field name
EMAIL_UPDATE	If Email updated, it should be true or false	by default, it is false
SESSION_KEY	Apptivo session key from username and password

* – Mandatory parameters

Output:

This will return the details of updated customer data with JSON format.

Sample Request URL:

https://www.apptivo.com/app/dao/v6/customers?a=update
&customerData={"customAttributes":[],"customerId":1090590,"customerName":"TestCustomer updated","customerNumber":"9","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":"INR","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","followUpDate":null,"followUpDescription":null,"createdByName":"Db2Es s","lastUpdatedByName":"Db2Es s","creationDate":"2017-10-07 05:30:02","lastUpdateDate":"2017-10-07 05:30:02","isExistingCustomer":"Y","isAffiliate":"Y","faceBookURL":"","twitterURL":"","linkedInURL":"","createdBy":76130,"lastUpdatedBy":null,"labels":[],"phoneNumbers":[],"removePhoneNumbers":[],"emailAddresses":[{"emailAddress":"[e-mail]","emailTypeCode":"BUSINESS","emailType":"Business","id":"cont_email_input"}],"addresses":[{"id":"address_section_attr_id_c1702415-3d39-4d8b-a8c7-27b9f511b719","addressId":12937411,"accountAddressId":987136,"addressAttributeId":"address_section_attr_id","addressType":"Billing Address","addressTypeCode":"1","addressLine1":"","addressLine2":"","city":"","state":"","stateCode":"","countryId":70,"countryName":"India","countryCode":"IN","zipCode":"","addressGroupName":"Address1","isAdded":false}],"affiliateLogoId":null}
&customerId=1090590
&attributeName=["customerName","emailAddresses"]
&isEmailAddressUpdate=true

Web Method: searchCustomers

Purpose:

This method used to get the number of leads in Apptivo based on the email address.

Request URL:

https://api.apptivo.com/app/dao/v6/customers?a=getAllByAdvancedSearch&numRecords=NUM_OF_RECORDS&searchData={SEARCH_DATA}&multiSelectData={}&apiKey=API_KEY&accesKey=ACCESS_KEY

Request Parameters:

Parameter	Data Type	Description
SEARCH_DATA	search data with Json format	please see the sample request URL
NUM_OF_RECORDS	number of records to return
SESSION_KEY	Apptivo session key from username and password

* – Mandatory parameters

Output:

This will return the number of customers with JSON format.

Sample Request URL:

https://www.apptivo.com/app/dao/v6/customers?a=getAllByAdvancedSearch
&startIndex=0
&numRecords=50
&iDisplayLength=50
&iDisplayStart=0
&searchData={"customerName":"","customerNumber":"test","assigneeObjectRefName":null,"assigneeObjectId":null,"assigneeObjectRefId":null,"description":"","followUpDescription":"","phoneNumbers":[],"emailAddresses":[],"skypeName":"","parentCustomerName":"","parentCustomerId":null,"website":"","tickerSymbol":"","campaignName":"","campaignId":null,"creditRating":"","territoryName":"","territoryId":null,"ownership":"","faceBookURL":"","twitterURL":"","linkedInURL":"","isUnsubscribed":null,"isBounced":null,"isResponded":null,"creationOnStartDate":"","creationOnEndDate":"","creationDateDuration":"","creationDateDurationTypeId":"","creationDateRangeTypeId":"","lastUpdateOnStartDate":"","lastUpdateOnEndDate":"","lastUpdateDateDuration":"","lastUpdateDateDurationTypeId":"","lastUpdateDateRangeTypeId":"","customAttributes":[],"addresses":[{"addressAttributeId":"address_section_attr_id","addressGroupName":"Address1","addressType":"","state":"","stateCode":"","stateId":null,"stateName":""}]}
multiSelectData:{"marketIds":[],"categoryIds":[],"statusIds":[],"employeeRangeIds":[],"paymentTermIds":[],"slaIds":[],"industryIds":[],"segmentIds":[]}
&objectId=3
&territoryType=MULTIPLE