LeadConnector

App · 20 actions

Manage contacts, notes, tasks and tags in a LeadConnector sub-account.

Actions

ActionWhat it does
Add tagsAdd Tags.
Create contactCreate Contact.
Create noteCreate Note.
Create taskCreate Task.
Delete contactDelete Contact.
Delete noteDelete Note.
Delete taskDelete Task.
Get contactGet Contact.
Get noteGet Note.
Get taskGet Task.
List appointmentsGet Appointments for Contact.
List notesGet All Notes.
List tasksGet all Tasks.
Remove tagsRemove Tags.
Search contactsSearch Contacts.
Set task completedUpdate Task Completed.
Update contactUpdate Contact.
Update noteUpdate Note.
Update taskUpdate Task.
Upsert contactUpsert Contact.

Add tags

Add Tags.

Inputs

Contactcontact_idtextRequired
Contact id.
TagstagslistRequired
Tags.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "tags": []
  }
}

Create contact

Create Contact.

Inputs

First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Namenametext
Name.
Emailemailtext
Email.
Location idlocation_idtext
Leave empty to use the connected sub-account.
Gendergendertext
Gender.
Phonephonetext
Phone.
Address1address1text
Address1.
Citycitytext
City.
Statestatetext
State.
Postal codepostal_codetext
Postal code.
Websitewebsitetext
Website.
Timezonetimezonetext
Timezone.
Dnddndtrue/false
Dnd.
Dnd settingsdnd_settingsobject
Dnd settings.
Inbound dnd settingsinbound_dnd_settingsobject
Inbound dnd settings.
Tagstagslist
Tags.
Custom fieldscustom_fieldslist
Custom fields.
Sourcesourcetext
Source.
Date of birthdate_of_birthobject
The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY
Countrycountrytext
Country.
Company namecompany_nametext
Company name.
Assigned toassigned_totext
User's Id

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "contact": {
      "address1": "example",
      "assignedTo": "example",
      "birthDay": 1.0,
      "birthMonth": 1.0,
      "bounceEmail": false,
      "businessId": "example",
      "city": "example",
      "companyName": "example",
      "country": "example",
      "customFields": [],
      "dateAdded": "example",
      "dateOfBirth": "example",
      "dateUpdated": "example",
      "deleted": false,
      "dnd": false,
      "dndSettings": {
        "Call": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "Email": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "FB": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "GMB": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "SMS": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "WhatsApp": {
          "code": "example",
          "message": "example",
          "status": "active"
        }
      },
      "email": "example",
      "emailLowerCase": "example",
      "firstName": "example",
      "firstNameLowerCase": "example",
      "fullNameLowerCase": "example",
      "id": "example",
      "lastName": "example",
      "lastNameLowerCase": "example",
      "lastSessionActivityAt": "example",
      "locationId": "example",
      "offers": [],
      "phone": "example",
      "postalCode": "example",
      "products": [],
      "source": "example",
      "state": "example",
      "tags": [],
      "type": "example",
      "unsubscribeEmail": false,
      "website": "example"
    }
  }
}

Create note

Create Note.

Inputs

Contactcontact_idtextRequired
Contact id.
User idservice_user_idtext
Service user id.
BodybodytextRequired
Body.
Titletitletext
Title.
Colorcolortext
Color.
Pinnedpinnedtrue/false
Pinned.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "note": {
      "body": "example",
      "color": "example",
      "contactId": "example",
      "dateAdded": "example",
      "id": "example",
      "pinned": false,
      "title": "example",
      "userId": "example"
    }
  }
}

Create task

Create Task.

Inputs

Contactcontact_idtextRequired
Contact id.
TitletitletextRequired
Title.
Bodybodytext
Body.
Due datedue_datedate and timeRequired
Due date.
Completedcompletedtrue/falseRequired
Completed.
Assigned toassigned_totext
Assigned to.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "task": {
      "assignedTo": "example",
      "body": "example",
      "completed": false,
      "contactId": "example",
      "dueDate": "example",
      "id": "example",
      "title": "example"
    }
  }
}

Delete contact

Delete Contact.

Inputs

Contactcontact_idtextRequired
Contact id.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "succeded": false
  }
}

Delete note

Delete Note.

Inputs

Contactcontact_idtextRequired
Contact id.
IdidtextRequired
Id.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "succeded": false
  }
}

Delete task

Delete Task.

Inputs

Contactcontact_idtextRequired
Contact id.
Task idtask_idtextRequired
Task id.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "succeded": false
  }
}

Get contact

Get Contact.

Inputs

Contactcontact_idtextRequired
Contact id.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "contact": {
      "address1": "example",
      "assignedTo": "example",
      "attachments": "example",
      "attributionSource": {
        "campaign": "example",
        "campaignId": "example",
        "dclid": "example",
        "fbEventId": "example",
        "fbc": "example",
        "fbclid": "example",
        "fbp": "example",
        "gclid": "example",
        "ip": "example",
        "medium": "example",
        "mediumId": "example",
        "msclikid": "example",
        "referrer": "example",
        "url": "example",
        "userAgent": "example",
        "utmContent": "example",
        "utmMedium": "example",
        "utmSource": "example"
      },
      "businessId": "example",
      "city": "example",
      "companyName": "example",
      "country": "example",
      "customFields": [],
      "dateAdded": "example",
      "dateOfBirth": "example",
      "dateUpdated": "example",
      "dnd": false,
      "dndSettings": {
        "Call": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "Email": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "FB": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "GMB": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "SMS": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "WhatsApp": {
          "code": "example",
          "message": "example",
          "status": "active"
        }
      },
      "email": "example",
      "emailLowerCase": "example",
      "firstName": "example",
      "firstNameLowerCase": "example",
      "fullNameLowerCase": "example",
      "id": "example",
      "keyword": "example",
      "lastActivity": "example",
      "lastAttributionSource": {
        "campaign": "example",
        "campaignId": "example",
        "dclid": "example",
        "fbEventId": "example",
        "fbc": "example",
        "fbclid": "example",
        "fbp": "example",
        "gclid": "example",
        "ip": "example",
        "medium": "example",
        "mediumId": "example",
        "msclikid": "example",
        "referrer": "example",
        "url": "example",
        "userAgent": "example",
        "utmContent": "example",
        "utmMedium": "example",
        "utmSource": "example"
      },
      "lastName": "example",
      "lastNameLowerCase": "example",
      "locationId": "example",
      "name": "example",
      "phone": "example",
      "postalCode": "example",
      "source": "example",
      "ssn": "example",
      "state": "example",
      "tags": [],
      "timezone": "example",
      "type": "example",
      "visitorId": "example",
      "website": "example"
    }
  }
}

Get note

Get Note.

Inputs

Contactcontact_idtextRequired
Contact id.
IdidtextRequired
Id.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "note": {
      "body": "example",
      "color": "example",
      "contactId": "example",
      "dateAdded": "example",
      "id": "example",
      "pinned": false,
      "title": "example",
      "userId": "example"
    }
  }
}

Get task

Get Task.

Inputs

Contactcontact_idtextRequired
Contact id.
Task idtask_idtextRequired
Task id.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "task": {
      "assignedTo": "example",
      "body": "example",
      "completed": false,
      "contactId": "example",
      "dueDate": "example",
      "id": "example",
      "title": "example"
    }
  }
}

List appointments

Get Appointments for Contact.

Inputs

Contactcontact_idtextRequired
Contact id.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "events": []
  }
}

List notes

Get All Notes.

Inputs

Contactcontact_idtextRequired
Contact id.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "notes": []
  }
}

List tasks

Get all Tasks.

Inputs

Contactcontact_idtextRequired
Contact id.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "tasks": []
  }
}

Remove tags

Remove Tags.

Inputs

Contactcontact_idtextRequired
Contact id.
TagstagslistRequired
Tags.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "tags": []
  }
}

Search contacts

Search Contacts.

Inputs

Location idlocation_idtext
Leave empty to use the connected sub-account.
Queryquerytext
Search the contact fields enabled in your sub-account.
Pagepagenumber
Page number, starting at 1. Do not combine with a cursor.At least 1.
Page limitpage_limitnumber
How many contacts to return per page, up to 500.From 1 to 500. Default: 100.
Search aftersearch_afterlist
Copy the searchAfter array from the last contact of the preceding page. Do not combine with Page.

Outputs

dataobject
One page of matching contacts.
Example output
{
  "data": {
    "contacts": [],
    "total": 1,
    "traceId": "example"
  }
}

Set task completed

Update Task Completed.

Inputs

Contactcontact_idtextRequired
Contact id.
Task idtask_idtextRequired
Task id.
Completedcompletedtrue/falseRequired
Completed.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "task": {
      "assignedTo": "example",
      "body": "example",
      "completed": false,
      "contactId": "example",
      "dueDate": "example",
      "id": "example",
      "title": "example"
    }
  }
}

Update contact

Update Contact.

Inputs

Contactcontact_idtextRequired
Contact id.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Namenametext
Name.
Emailemailtext
Email.
Phonephonetext
Phone.
Address1address1text
Address1.
Citycitytext
City.
Statestatetext
State.
Postal codepostal_codetext
Postal code.
Websitewebsitetext
Website.
Timezonetimezonetext
Timezone.
Dnddndtrue/false
Dnd.
Dnd settingsdnd_settingsobject
Dnd settings.
Inbound dnd settingsinbound_dnd_settingsobject
Inbound dnd settings.
Tagstagslist
This field will overwrite all current tags associated with the contact. To update a tags, it is recommended to use the Add Tag or Remove Tag API instead.
Custom fieldscustom_fieldslist
Custom fields.
Sourcesourcetext
Source.
Date of birthdate_of_birthobject
The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY
Countrycountrytext
Country.
Assigned toassigned_totext
User's Id

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "contact": {
      "address1": "example",
      "assignedTo": "example",
      "attachments": "example",
      "attributionSource": {
        "campaign": "example",
        "campaignId": "example",
        "dclid": "example",
        "fbEventId": "example",
        "fbc": "example",
        "fbclid": "example",
        "fbp": "example",
        "gclid": "example",
        "ip": "example",
        "medium": "example",
        "mediumId": "example",
        "msclikid": "example",
        "referrer": "example",
        "url": "example",
        "userAgent": "example",
        "utmContent": "example",
        "utmMedium": "example",
        "utmSource": "example"
      },
      "businessId": "example",
      "city": "example",
      "companyName": "example",
      "country": "example",
      "customFields": [],
      "dateAdded": "example",
      "dateOfBirth": "example",
      "dateUpdated": "example",
      "dnd": false,
      "dndSettings": {
        "Call": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "Email": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "FB": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "GMB": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "SMS": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "WhatsApp": {
          "code": "example",
          "message": "example",
          "status": "active"
        }
      },
      "email": "example",
      "emailLowerCase": "example",
      "firstName": "example",
      "firstNameLowerCase": "example",
      "fullNameLowerCase": "example",
      "id": "example",
      "keyword": "example",
      "lastActivity": "example",
      "lastAttributionSource": {
        "campaign": "example",
        "campaignId": "example",
        "dclid": "example",
        "fbEventId": "example",
        "fbc": "example",
        "fbclid": "example",
        "fbp": "example",
        "gclid": "example",
        "ip": "example",
        "medium": "example",
        "mediumId": "example",
        "msclikid": "example",
        "referrer": "example",
        "url": "example",
        "userAgent": "example",
        "utmContent": "example",
        "utmMedium": "example",
        "utmSource": "example"
      },
      "lastName": "example",
      "lastNameLowerCase": "example",
      "locationId": "example",
      "name": "example",
      "phone": "example",
      "postalCode": "example",
      "source": "example",
      "ssn": "example",
      "state": "example",
      "tags": [],
      "timezone": "example",
      "type": "example",
      "visitorId": "example",
      "website": "example"
    },
    "succeded": false
  }
}

Update note

Update Note.

Inputs

Contactcontact_idtextRequired
Contact id.
IdidtextRequired
Id.
User idservice_user_idtext
Service user id.
Bodybodytext
Body.
Titletitletext
Title.
Colorcolortext
Color.
Pinnedpinnedtrue/false
Pinned.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "note": {
      "body": "example",
      "color": "example",
      "contactId": "example",
      "dateAdded": "example",
      "id": "example",
      "pinned": false,
      "title": "example",
      "userId": "example"
    }
  }
}

Update task

Update Task.

Inputs

Contactcontact_idtextRequired
Contact id.
Task idtask_idtextRequired
Task id.
Titletitletext
Title.
Bodybodytext
Body.
Due datedue_datedate and time
Due date.
Completedcompletedtrue/false
Completed.
Assigned toassigned_totext
Assigned to.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "task": {
      "assignedTo": "example",
      "body": "example",
      "completed": false,
      "contactId": "example",
      "dueDate": "example",
      "id": "example",
      "title": "example"
    }
  }
}

Upsert contact

Upsert Contact.

Inputs

First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Namenametext
Name.
Emailemailtext
Email.
Location idlocation_idtext
Leave empty to use the connected sub-account.
Gendergendertext
Gender.
Phonephonetext
Phone.
Address1address1text
Address1.
Citycitytext
City.
Statestatetext
State.
Postal codepostal_codetext
Postal code.
Websitewebsitetext
Website.
Timezonetimezonetext
Timezone.
Dnddndtrue/false
Dnd.
Dnd settingsdnd_settingsobject
Dnd settings.
Inbound dnd settingsinbound_dnd_settingsobject
Inbound dnd settings.
Tagstagslist
This field will overwrite all current tags associated with the contact. To update a tags, it is recommended to use the Add Tag or Remove Tag API instead.
Custom fieldscustom_fieldslist
Custom fields.
Sourcesourcetext
Source.
Date of birthdate_of_birthobject
The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY
Countrycountrytext
Country.
Company namecompany_nametext
Company name.
Assigned toassigned_totext
User's Id
Create new if duplicate allowedcreate_new_if_duplicate_allowedtrue/false
Controls whether to create a new contact or update an existing duplicate. **Scenario 1:** If this value is `true` and the location allows duplicate contacts, a new contact will be created immediately without checking for duplicates. **Scenario 2:** If this value is `true` but the location does not allow duplicate contacts, this field is ignored and the normal upsert behavior applies: the API will search for an existing duplicate contact, update it if found, or create a new contact if not found. **Scenario 3:** If this value is `false` or not provided, the normal upsert behavior applies regardless of the location's duplicate contact setting.Default: false.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "contact": {
      "address1": "example",
      "assignedTo": "example",
      "attachments": "example",
      "attributionSource": {
        "campaign": "example",
        "campaignId": "example",
        "dclid": "example",
        "fbEventId": "example",
        "fbc": "example",
        "fbclid": "example",
        "fbp": "example",
        "gclid": "example",
        "ip": "example",
        "medium": "example",
        "mediumId": "example",
        "msclikid": "example",
        "referrer": "example",
        "url": "example",
        "userAgent": "example",
        "utmContent": "example",
        "utmMedium": "example",
        "utmSource": "example"
      },
      "businessId": "example",
      "city": "example",
      "companyName": "example",
      "country": "example",
      "customFields": [],
      "dateAdded": "example",
      "dateOfBirth": "example",
      "dateUpdated": "example",
      "dnd": false,
      "dndSettings": {
        "Call": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "Email": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "FB": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "GMB": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "SMS": {
          "code": "example",
          "message": "example",
          "status": "active"
        },
        "WhatsApp": {
          "code": "example",
          "message": "example",
          "status": "active"
        }
      },
      "email": "example",
      "emailLowerCase": "example",
      "firstName": "example",
      "firstNameLowerCase": "example",
      "fullNameLowerCase": "example",
      "id": "example",
      "keyword": "example",
      "lastActivity": "example",
      "lastAttributionSource": {
        "campaign": "example",
        "campaignId": "example",
        "dclid": "example",
        "fbEventId": "example",
        "fbc": "example",
        "fbclid": "example",
        "fbp": "example",
        "gclid": "example",
        "ip": "example",
        "medium": "example",
        "mediumId": "example",
        "msclikid": "example",
        "referrer": "example",
        "url": "example",
        "userAgent": "example",
        "utmContent": "example",
        "utmMedium": "example",
        "utmSource": "example"
      },
      "lastName": "example",
      "lastNameLowerCase": "example",
      "locationId": "example",
      "name": "example",
      "phone": "example",
      "postalCode": "example",
      "source": "example",
      "ssn": "example",
      "state": "example",
      "tags": [],
      "timezone": "example",
      "type": "example",
      "visitorId": "example",
      "website": "example"
    },
    "new": false,
    "traceId": "example"
  }
}

On this page