LeadSquared Developer Centre

ON THIS PAGE

API
Developer Apps

Post an Activity on a Lead (Async)

Try it

Posts an activity on a lead. Functionality is the same as the synchronous Post Activity on Lead API, with the following differences –

API host is different, see Async API.
The URL is slightly different (see API URL below).
An additional x-api-key must be passed in the header, see Async API. Content-Type is application-json.
Returns a RequestId parameter in the response. This must be passed in the Status API to get the status of the request.
To get metrics for this Async API, see Get Post Activity on Lead Metrics API.

API URL

URL

POST https://{async-host}/activity/create? accessKey=AccessKey&secretKey=SecretKey

Request

Content-Type: application/json

JSON Body/Payload Icon

Request Parameters

Parameter	Description
RelatedProspectId	Lead Id (ProspectId) of the lead you want to post the activity on.
ActivityEvent	Activity Event Code that specifies the activity type. Get it using Get List of Activity Types API.
ActivityNote	Notes related to the activity.
ActivityDateTime	Activity date and time in yyyy-mm-dd hh:mm:ss format.
Fields	Pass the activity fields (schema names) and values here.

Response

200 OK

Content-Type: application/json

HTTP Response Codes

Code	Description
200 OK	This is the status code for successful API call.
401 Unauthorized	The API call was made with invalid access credentials. Check your AccessKey and SecretKey.
400 Bad Request	The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.
404 Not Found	The API could not be found. Please check the API signature.
429 Too Many Requests	API calls exceeded the limit of 25 in 5 second(s)
500 Internal Server Error	The API called failed. There could be many reasons for it. Check the exception message to get more details.

POST https://{async-host}/activity/create?accessKey=Access Key&secretKey=Secret Key

URL Parameters

Access Key

Secret Key

Body

{
   "RelatedProspectId":"00727844-51aa-11e2-9e64-12314004ac6b",
   "ActivityEvent":201,
   "ActivityNote":"Your Activity Note",
   "ActivityDateTime":"2015-10-11 12:13:44",
   "Fields":[
      {
         "SchemaName":"mx_Custom_1",
         "Value":"123123123"
      },
      {
         "SchemaName":"mx_Custom_2",
         "Value":"123"
      },
      {
         "SchemaName":"mx_Custom_3",
         "Value":"3"
      },
      {
         "SchemaName":"mx_Custom_4",
         "Value":"4"
      },
      {
         "SchemaName":"mx_Custom_5",
         "Value":"2016-07-07 10:55:00"
      },
      {
         "SchemaName":"mx_Custom_6",
         "Value":"Value for Custom field"
      },
      {
         "SchemaName":"mx_Custom_7",
         "Value":"Value for Custom field"
      },
      {
         "SchemaName":"mx_Custom_8",
         "Value":"1"
      },
      {
         "SchemaName":"mx_Custom_9",
         "Value":"Value for Custom field"
      },
      {
         "SchemaName":"mx_Custom_10",
         "Value":""
      },
      {
         "SchemaName":"mx_Custom_11",
         "Value":""
      },
      {
         "SchemaName":"mx_Custom_12",
         "Value":""
      },
      {
         "SchemaName":"mx_Custom_13",
         "Value":"Value for Custom field"
      },
      {
         "SchemaName":"mx_Custom_14",
         "Value":"Value for Custom field"
      },
      {
         "SchemaName":"mx_Custom_15",
         "Value":"asd"
      }
   ]
}

Reset

Response

You have not yet submited

Generate Code

PHP


<?php $url = $url;
$data_string = "<?php echo $json_data; ?>";
try
    {
    $curl = curl_init($url);
    curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($curl, CURLOPT_HEADER, 0);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $data_string);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($curl, CURLOPT_HTTPHEADER, array(
        "Content-Type:application/json",
        "Content-Length:".strlen($data_string)
    ));
    $response = curl_exec($curl);
        curl_close($curl);
        if ($err) {
            echo "cURL Error #:" . $err;
        }else{
            echo $response;
        }
    } catch (Exception $ex) {
        curl_close($curl);
    }?>


import requests
url = "<?php echo $surl; ?>"
querystring = <?php echo $jsqry;?>
payload = <?php var_export(str_replace(" ","",$json_data; ?>
headers = {
        "content-type": "application/json",
        "cache-control": "no-cache"
    }
        response = requests.request("POST", url, data=payload, headers=headers, params=querystring)
        print(response.text)

Generate Code