createLead

Purpose:

You can use createLead method to create leads in Apptivo with generic fields provided by application.

Request URL:

https://api.apptivo.com/app/dao/leads?a=createLead&leadData={LEAD_DATA}&apiKey=API_KEY&accesKey=ACCESS_KEY

Request Parameters:

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

* – Mandatory parameter

Output:

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

Sample Request URL:

https://api.apptivo.com/app/dao/leads?a=createLead&leadData={"title":null,"":"","firstName":"Mark","lastName":"Henry","jobTitle":"","easyWayToContact":"EMAIL","wayToContact":"Email","leadStatus":"1","leadStatusMeaning":"New","leadSource":"CLOUDBYTE","leadSourceMeaning":"CloudByte","leadTypeName":"","leadTypeId":-1,"referredByName":"Sofia Meyer","referredById":12756,"assigneeObjectRefName":"Sofia Meyer","assigneeObjectRefId":12756,"assigneeObjectId":8,"description":"","skypeName":"","potentialAmount":null,"currencyCode":"USD","estimatedCloseDate":"","leadRank":"1","leadRankMeaning":"High","campaignName":"","campaignId":null,"territoryName":"","territoryId":null,"marketId":null,"marketName":null,"segmentId":null,"segmentName":null,"followUpDate":null,"followUpDescription":null,"createdByName":"","lastUpdatedByName":"","creationDate":"","lastUpdateDate":"","accountName":"","accountId":null,"companyName":"","employeeRangeId":null,"employeeRange":null,"annualRevenue":null,"industry":"","industryName":"","ownership":"","website":"","faceBookURL":"","twitterURL":"","linkedInURL":"","phoneNumbers":[],"emailAddresses":[{"emailAddress":"olive@appsio.com","emailTypeCode":"BUSINESS","emailType":"Business","id":"cont_email_input"}],"addresses":[{"addressAttributeId":"address_section_attr_id","addressTypeCode":"1","addressType":"Billing Address","addressLine1":"","addressLine2":"","city":"","stateCode":"","state":"Select One","zipCode":"","countryId":176,"countryName":"United States"}],"labels":[],"customAttributes":[{"customAttributeType":"input","id":"attribute_input_1390571754355_1421","customAttributeName":"attribute_input_1390571754355_1421","customAttributeId":"attribute_input_1390571754355_1421","customAttributeValue":"c"}],"createdBy":null,"lastUpdatedBy":null}&apiKey=3f465de0-a2f9-4f11-8f07-98472bc10ad9&accessKey=cDxRzRzJVzTT-CHVDHAhEZOtT-4e2e159a-34b9-4536-a964-776b0454ecf5

  • >   CreateCase
  • >   updateCase
  • >   createLead

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

    createLead

    Purpose:

    You can use createLead method to create leads in Apptivo with generic fields provided by application.

    Request URL:

    https://api.apptivo.com/app/dao/leads?a=createLead&leadData={LEAD_DATA}&apiKey=API_KEY&accesKey=ACCESS_KEY

    Request Parameters:

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

    * – Mandatory parameter

    Output:

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

    Sample Request URL:

    https://api.apptivo.com/app/dao/leads?a=createLead&leadData={"title":null,"":"","firstName":"Mark","lastName":"Henry","jobTitle":"","easyWayToContact":"EMAIL","wayToContact":"Email","leadStatus":"1","leadStatusMeaning":"New","leadSource":"CLOUDBYTE","leadSourceMeaning":"CloudByte","leadTypeName":"","leadTypeId":-1,"referredByName":"Sofia Meyer","referredById":12756,"assigneeObjectRefName":"Sofia Meyer","assigneeObjectRefId":12756,"assigneeObjectId":8,"description":"","skypeName":"","potentialAmount":null,"currencyCode":"USD","estimatedCloseDate":"","leadRank":"1","leadRankMeaning":"High","campaignName":"","campaignId":null,"territoryName":"","territoryId":null,"marketId":null,"marketName":null,"segmentId":null,"segmentName":null,"followUpDate":null,"followUpDescription":null,"createdByName":"","lastUpdatedByName":"","creationDate":"","lastUpdateDate":"","accountName":"","accountId":null,"companyName":"","employeeRangeId":null,"employeeRange":null,"annualRevenue":null,"industry":"","industryName":"","ownership":"","website":"","faceBookURL":"","twitterURL":"","linkedInURL":"","phoneNumbers":[],"emailAddresses":[{"emailAddress":"olive@appsio.com","emailTypeCode":"BUSINESS","emailType":"Business","id":"cont_email_input"}],"addresses":[{"addressAttributeId":"address_section_attr_id","addressTypeCode":"1","addressType":"Billing Address","addressLine1":"","addressLine2":"","city":"","stateCode":"","state":"Select One","zipCode":"","countryId":176,"countryName":"United States"}],"labels":[],"customAttributes":[{"customAttributeType":"input","id":"attribute_input_1390571754355_1421","customAttributeName":"attribute_input_1390571754355_1421","customAttributeId":"attribute_input_1390571754355_1421","customAttributeValue":"c"}],"createdBy":null,"lastUpdatedBy":null}&apiKey=3f465de0-a2f9-4f11-8f07-98472bc10ad9&accessKey=cDxRzRzJVzTT-CHVDHAhEZOtT-4e2e159a-34b9-4536-a964-776b0454ecf5

  • >   updateLead