Leads

List Leads

Example Request

curl -i https://api.oktopost.com/v2/lead

Input

  • search (optional) search by email

Example Result

{
  "Result": true,
  "Items": [
    {
      "Id": "0ld000000000001",
      "ParentId": null,      
      "AccountId": "00100000000001",
      "Type": "person",
      "Email": "john@example.com",
      "Name": "John Doe",
      "Photo": null,
      "Phone": null,
      "IsTracked": true
    }
  ]
}

Get Lead

Example Request

curl -i https://api.oktopost.com/v2/lead/0ld000000000001

Example Result

{
  "Result": true,
  "Lead": {
      "Id": "0ld000000000001",
      "ParentId": null,      
      "AccountId": "00100000000001",
      "Type": "person",
      "Email": "john@example.com",
      "Name": "John Doe",
      "Photo": null,
      "Phone": null,
      "IsTracked": true
    }
}

Delete Lead

Example Request

curl -i https://api.oktopost.com/v2/lead/0ld000000000001 -X DELETE

Feedback and Knowledge Base