LeadConnector
App · 20 actions
Manage contacts, notes, tasks and tags in a LeadConnector sub-account.
Actions
| Action | What it does |
|---|---|
| Add tags | Add Tags. |
| Create contact | Create Contact. |
| Create note | Create Note. |
| Create task | Create Task. |
| Delete contact | Delete Contact. |
| Delete note | Delete Note. |
| Delete task | Delete Task. |
| Get contact | Get Contact. |
| Get note | Get Note. |
| Get task | Get Task. |
| List appointments | Get Appointments for Contact. |
| List notes | Get All Notes. |
| List tasks | Get all Tasks. |
| Remove tags | Remove Tags. |
| Search contacts | Search Contacts. |
| Set task completed | Update Task Completed. |
| Update contact | Update Contact. |
| Update note | Update Note. |
| Update task | Update Task. |
| Upsert contact | Upsert Contact. |
Add tags
Add Tags.
Inputs
- Contact
contact_idtextRequired - Contact id.
- Tags
tagslistRequired - Tags.
Outputs
dataobject- Service response.
Example output
{
"data": {
"tags": []
}
}Create contact
Create Contact.
Inputs
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Name
nametext - Name.
- Email
emailtext - Email.
- Location id
location_idtext - Leave empty to use the connected sub-account.
- Gender
gendertext - Gender.
- Phone
phonetext - Phone.
- Address1
address1text - Address1.
- City
citytext - City.
- State
statetext - State.
- Postal code
postal_codetext - Postal code.
- Website
websitetext - Website.
- Timezone
timezonetext - Timezone.
- Dnd
dndtrue/false - Dnd.
- Dnd settings
dnd_settingsobject - Dnd settings.
- Inbound dnd settings
inbound_dnd_settingsobject - Inbound dnd settings.
- Tags
tagslist - Tags.
- Custom fields
custom_fieldslist - Custom fields.
- Source
sourcetext - Source.
- Date of birth
date_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
- Country
countrytext - Country.
- Company name
company_nametext - Company name.
- Assigned to
assigned_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
- Contact
contact_idtextRequired - Contact id.
- User id
service_user_idtext - Service user id.
- Body
bodytextRequired - Body.
- Title
titletext - Title.
- Color
colortext - Color.
- Pinned
pinnedtrue/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
- Contact
contact_idtextRequired - Contact id.
- Title
titletextRequired - Title.
- Body
bodytext - Body.
- Due date
due_datedate and timeRequired - Due date.
- Completed
completedtrue/falseRequired - Completed.
- Assigned to
assigned_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
- Contact
contact_idtextRequired - Contact id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"succeded": false
}
}Delete note
Delete Note.
Inputs
- Contact
contact_idtextRequired - Contact id.
- Id
idtextRequired - Id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"succeded": false
}
}Delete task
Delete Task.
Inputs
- Contact
contact_idtextRequired - Contact id.
- Task id
task_idtextRequired - Task id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"succeded": false
}
}Get contact
Get Contact.
Inputs
- Contact
contact_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
- Contact
contact_idtextRequired - Contact id.
- Id
idtextRequired - 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
- Contact
contact_idtextRequired - Contact id.
- Task id
task_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
- Contact
contact_idtextRequired - Contact id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"events": []
}
}List notes
Get All Notes.
Inputs
- Contact
contact_idtextRequired - Contact id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"notes": []
}
}List tasks
Get all Tasks.
Inputs
- Contact
contact_idtextRequired - Contact id.
Outputs
dataobject- Service response.
Example output
{
"data": {
"tasks": []
}
}Remove tags
Remove Tags.
Inputs
- Contact
contact_idtextRequired - Contact id.
- Tags
tagslistRequired - Tags.
Outputs
dataobject- Service response.
Example output
{
"data": {
"tags": []
}
}Search contacts
Search Contacts.
Inputs
- Location id
location_idtext - Leave empty to use the connected sub-account.
- Query
querytext - Search the contact fields enabled in your sub-account.
- Page
pagenumber - Page number, starting at 1. Do not combine with a cursor.At least 1.
- Page limit
page_limitnumber - How many contacts to return per page, up to 500.From 1 to 500. Default:
100. - Search after
search_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
- Contact
contact_idtextRequired - Contact id.
- Task id
task_idtextRequired - Task id.
- Completed
completedtrue/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
- Contact
contact_idtextRequired - Contact id.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Name
nametext - Name.
- Email
emailtext - Email.
- Phone
phonetext - Phone.
- Address1
address1text - Address1.
- City
citytext - City.
- State
statetext - State.
- Postal code
postal_codetext - Postal code.
- Website
websitetext - Website.
- Timezone
timezonetext - Timezone.
- Dnd
dndtrue/false - Dnd.
- Dnd settings
dnd_settingsobject - Dnd settings.
- Inbound dnd settings
inbound_dnd_settingsobject - Inbound dnd settings.
- Tags
tagslist - 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 fields
custom_fieldslist - Custom fields.
- Source
sourcetext - Source.
- Date of birth
date_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
- Country
countrytext - Country.
- Assigned to
assigned_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
- Contact
contact_idtextRequired - Contact id.
- Id
idtextRequired - Id.
- User id
service_user_idtext - Service user id.
- Body
bodytext - Body.
- Title
titletext - Title.
- Color
colortext - Color.
- Pinned
pinnedtrue/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
- Contact
contact_idtextRequired - Contact id.
- Task id
task_idtextRequired - Task id.
- Title
titletext - Title.
- Body
bodytext - Body.
- Due date
due_datedate and time - Due date.
- Completed
completedtrue/false - Completed.
- Assigned to
assigned_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 name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Name
nametext - Name.
- Email
emailtext - Email.
- Location id
location_idtext - Leave empty to use the connected sub-account.
- Gender
gendertext - Gender.
- Phone
phonetext - Phone.
- Address1
address1text - Address1.
- City
citytext - City.
- State
statetext - State.
- Postal code
postal_codetext - Postal code.
- Website
websitetext - Website.
- Timezone
timezonetext - Timezone.
- Dnd
dndtrue/false - Dnd.
- Dnd settings
dnd_settingsobject - Dnd settings.
- Inbound dnd settings
inbound_dnd_settingsobject - Inbound dnd settings.
- Tags
tagslist - 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 fields
custom_fieldslist - Custom fields.
- Source
sourcetext - Source.
- Date of birth
date_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
- Country
countrytext - Country.
- Company name
company_nametext - Company name.
- Assigned to
assigned_totext - User's Id
- Create new if duplicate allowed
create_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"
}
}