Leads

Parameters #

• {leadId} either the lead id or the external_id

• owner : an Agent that owns a lead.
  owner can be provided as either an Agent Full Name or id:
  
  
  • Full Name
    Agents full name separating the first and last name with a space.
    owner : “John Smith”
    
  • Id
    Agents ==> Edit Agent ==> id (top right corner)
    owner : “160404259385146436782”

Get Lead #

Returns a lead object.

https://app.mycallassist.com/api/v1/leads/{leadId}

Response

{
  "id": "5f97674b3e575400179dc139",
  "external_id": "123456",
  "first": "John",
  "last": "Smith",
  "national": "15555555555",
  "email": "jsmith@example.com",
  "status": "Waiting",
  "result": "Unknown",
  "tags": [
            "Website"
           ],
   "owner": {
             "id": "5f94a83ad5de1e0017fe6950",
             "name": "Hilary Simpson"
            },
  "team": {
            "id": "5f97641c3e575400179dc116",
            "name": "Alpha Team"
          },
  "company": "ABC Systems",
  "category": "Website",
  "comments": "Please help with purchase"
}

Get Leads #

Returns a list of lead objects.

https://app.mycallassist.com/api/v1/leads

Response

{
    "data": [
        {
            "id": "5f97674b3e575400179dc139",
            "external_id": "123456",
            "first": "John",
            "last": "Smith",
            "national": "15555555555",
            "email": "jsmith@example.com",
            "status": "Waiting",
            "result": "Unknown",
            "tags": [
                "Website"
            ],
            "owner": {
                "id": "5f94a83ad5de1e0017fe6950",
                "name": "Hilary Simpson"
            },
            "team": {
                "id": "5f97641c3e575400179dc116",
                "name": "Alpha Team"
            },
            "company": "ABC Systems",
            "category": "Website",
            "comments": "Please help with purchase"
        },
        {...},
        {...},
    ],
    "count": 3,
    "total": 3,
    "links": {
        "self": "/api/v1/leads?offset=0&limit=10"
    }
}

Update Lead #

Updates a lead.

https://app.mycallassist.com/api/v1/leads/{leadId}

Request

{
  "external_id": "123456",
  "first": "John",
  "last": "Smith",
  "national": "15555555555",
  "email": "jsmith@example.com",
  "status": "Waiting",
  "result": "Unknown",
  "tags": [
            "Website"
           ],
  "owner": "Hilary Simpson",
  "team": "Alpha Team"
  "company": "ABC Systems",
  "category": "Website",
  "comments": "Please help with purchase"
}

Create Lead #

Creates a lead.

https://app.mycallassist.com/api/v1/lead

Request

{
  "external_id": "123456",
  "first": "John",
  "last": "Smith",
  "national": "15555555555",
  "email": "jsmith@example.com",
  "status": "Waiting",
  "result": "Unknown",
  "tags": [
            "Website"
           ],
  "owner": "Hilary Simpson",
  "team": "Alpha Team"
  "company": "ABC Systems",
  "category": "Website",
  "comments": "Please help with purchase"
}