updateLead

Purpose:

This method used to update the lead information.

Request URL:

https://api.apptivo.com/app/dao/v6/leads?a=update&leadData={LEAD_DATA_VALUES}&attributeNames=[LEAD_DATA_NAME]&objectId=4&leadId=LEAD_ID&isEmailAddressUpdate=EMAIL_UPDATE&apiKey=API_KEY&accesKey=ACCESS_KEY

Request Parameters:

Parameter Data Type Description
LEAD_ID Lead ID
LEAD_DATA_VALUES Updated field value
LEAD_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 parameter

Output:

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

Sample Request URL:

https://api.apptivo.com/app/dao/v6/leads?a=update&leadData={"id":"301425","objectId":4,"leadId":301425,"lastName":"lastname update","fullName":"Testlead","leadStatus":"1","leadStatusMeaning":"New","leadSource":"1","leadSourceMeaning":"Cold Call","wayToContact":"Email","easyWayToContact":"EMAIL","assigneeObjectRefId":44479,"assigneeObjectRefName":"lead test","assigneeObjectId":8,"referredById":44479,"referredByName":"lead test","description":"","potentialAmount":"0.00","segmentName":"","followUpDate":"N/A","objectStatus":"0","isActive":"Y","actualAmount":0,"currencyCode":"ALL","potentialAmountCurrencyCode":"ALL","annualRevenueCurrencyCode":"ALL","isUnsubscribed":"Y","labels":[],"removeLabels":[],"addresses":[{"addressId":6506316,"addressAttributeId":"address_section_attr_id","addressType":"Billing Address","addressTypeCode":"1","addressLine1":"","addressLine2":"","city":"","county":"","state":"","stateCode":"","countryId":2,"countryName":"Albania","countryCode":"AL","zipCode":"","addressGroupName":"","isAdded":false}],"removeAddresses":[],"phoneNumbers":[],"removePhoneNumbers":[{"id":"lead_phone_input","phoneType":"Business","phoneTypeCode":"PHONE_BUSINESS"}],"emailAddresses":[{"id":"cont_email_input","emailType":"Business","emailTypeCode":"BUSINESS","emailAddress":"testupdate@gmail.com","communicationId":11879597}],"removeEmailAddresses":[],"customAttributes":[{"customAttributeId":"select_1471954940520_71_914251471954940520_907","customAttributeValue":"","customAttributeType":"select","customAttributeTagName":"select_1471954940520_213_1187951471954940520_362","customAttributeName":"select_1471954940520_213_1187951471954940520_362","select_1471954940520_213_1187951471954940520_362":""}],"notes":[],"accounts":[],"firmId":193350,"lastContactedDate":"Not Contacted","createdBy":44753,"lastUpdatedBy":44753,"createdByName":"lead test","creationDate":"Aug 30, 2016 12:29:55 PM","lastUpdateDate":"Aug 30, 2016 12:29:55 PM","lastUpdatedByName":"lead test","version":1,"tags":[],"phoneType":"Business","phoneTypeCode":"PHONE_BUSINESS","emailType":"Business","emailTypeCode":"BUSINESS","isDirtypage":null}&leadId=301425&attributeNames=["lastName","emailAddresses"]&isCustomAttributesUpdate=&isAddTag=&isRemoveTag=&isAddressUpdate=&isPhoneNumberUpdate=&isEmailAddressUpdate=1&isEmailAddressDelete=&isPhoneNumberDelete=&isAddressDelete=&apiKey=oRxYzRZRvOTH-cTPBPVPArJnVNW-6a8d8bf4-1c5f-4930-a5da-49f380afcd33&accessKey=3g806jxv5gq7Q62E

  • >   CreateCase
  • >   updateCase
  • >   createLead
  • >   updateLead

    User Manual >> Documentation >> Developer API >> Leads API Reference >> updateLead

    updateLead

    Purpose:

    This method used to update the lead information.

    Request URL:

    https://api.apptivo.com/app/dao/v6/leads?a=update&leadData={LEAD_DATA_VALUES}&attributeNames=[LEAD_DATA_NAME]&objectId=4&leadId=LEAD_ID&isEmailAddressUpdate=EMAIL_UPDATE&apiKey=API_KEY&accesKey=ACCESS_KEY

    Request Parameters:

    Parameter Data Type Description
    LEAD_ID Lead ID
    LEAD_DATA_VALUES Updated field value
    LEAD_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 parameter

    Output:

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

    Sample Request URL:

    https://api.apptivo.com/app/dao/v6/leads?a=update&leadData={"id":"301425","objectId":4,"leadId":301425,"lastName":"lastname update","fullName":"Testlead","leadStatus":"1","leadStatusMeaning":"New","leadSource":"1","leadSourceMeaning":"Cold Call","wayToContact":"Email","easyWayToContact":"EMAIL","assigneeObjectRefId":44479,"assigneeObjectRefName":"lead test","assigneeObjectId":8,"referredById":44479,"referredByName":"lead test","description":"","potentialAmount":"0.00","segmentName":"","followUpDate":"N/A","objectStatus":"0","isActive":"Y","actualAmount":0,"currencyCode":"ALL","potentialAmountCurrencyCode":"ALL","annualRevenueCurrencyCode":"ALL","isUnsubscribed":"Y","labels":[],"removeLabels":[],"addresses":[{"addressId":6506316,"addressAttributeId":"address_section_attr_id","addressType":"Billing Address","addressTypeCode":"1","addressLine1":"","addressLine2":"","city":"","county":"","state":"","stateCode":"","countryId":2,"countryName":"Albania","countryCode":"AL","zipCode":"","addressGroupName":"","isAdded":false}],"removeAddresses":[],"phoneNumbers":[],"removePhoneNumbers":[{"id":"lead_phone_input","phoneType":"Business","phoneTypeCode":"PHONE_BUSINESS"}],"emailAddresses":[{"id":"cont_email_input","emailType":"Business","emailTypeCode":"BUSINESS","emailAddress":"testupdate@gmail.com","communicationId":11879597}],"removeEmailAddresses":[],"customAttributes":[{"customAttributeId":"select_1471954940520_71_914251471954940520_907","customAttributeValue":"","customAttributeType":"select","customAttributeTagName":"select_1471954940520_213_1187951471954940520_362","customAttributeName":"select_1471954940520_213_1187951471954940520_362","select_1471954940520_213_1187951471954940520_362":""}],"notes":[],"accounts":[],"firmId":193350,"lastContactedDate":"Not Contacted","createdBy":44753,"lastUpdatedBy":44753,"createdByName":"lead test","creationDate":"Aug 30, 2016 12:29:55 PM","lastUpdateDate":"Aug 30, 2016 12:29:55 PM","lastUpdatedByName":"lead test","version":1,"tags":[],"phoneType":"Business","phoneTypeCode":"PHONE_BUSINESS","emailType":"Business","emailTypeCode":"BUSINESS","isDirtypage":null}&leadId=301425&attributeNames=["lastName","emailAddresses"]&isCustomAttributesUpdate=&isAddTag=&isRemoveTag=&isAddressUpdate=&isPhoneNumberUpdate=&isEmailAddressUpdate=1&isEmailAddressDelete=&isPhoneNumberDelete=&isAddressDelete=&apiKey=oRxYzRZRvOTH-cTPBPVPArJnVNW-6a8d8bf4-1c5f-4930-a5da-49f380afcd33&accessKey=3g806jxv5gq7Q62E