Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.hoopai.com/llms.txt

Use this file to discover all available pages before exploring further.

The Contacts API provides full CRUD access to contact records within the HoopAI Platform. Use it to create and update leads, search contacts using advanced filters, manage tags and custom fields, attach notes and tasks, add contacts to campaigns and workflows, and handle deduplication across locations. It is the foundational data layer for automation, CRM, and outreach workflows.

​
Base URL

https://services.leadconnectorhq.com

​
Authentication

All endpoints require a Bearer token and an API version header. 
Authorization: Bearer <access_token>
Version: 2021-07-28
See OAuth 2.0 to obtain an access token.

​
OAuth scopes

ScopeAccess
contacts.readonlyRead contacts, tasks, notes, appointments, and tags
contacts.writeCreate, update, and delete contacts, tasks, notes, tags, and followers

​
Quick start

Create a new contact in a location: 
curl -X POST https://services.leadconnectorhq.com/contacts/ \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28" \
  -H "Content-Type: application/json" \
  -d '{
    "locationId": "sadadya1u12basyhasd",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane.doe@example.com",
    "phone": "+14155552671",
    "tags": ["lead", "webinar"]
  }'

​
Endpoints

MethodPathDescription
GET/contacts/Get contacts
POST/contacts/Create contact
GET/contacts/{contactId}Get contact
PUT/contacts/{contactId}Update contact
DELETE/contacts/{contactId}Delete contact
POST/contacts/upsertUpsert contact
POST/contacts/searchSearch contacts
GET/contacts/search/duplicateGet duplicate contact
GET/contacts/business/{businessId}Get contacts by business ID
POST/contacts/bulk/tags/update/{type}Update contacts tags (bulk)
POST/contacts/bulk/businessAdd or remove contacts from business (bulk)
GET/contacts/{contactId}/tasksGet all tasks
POST/contacts/{contactId}/tasksCreate task
GET/contacts/{contactId}/tasks/{taskId}Get task
PUT/contacts/{contactId}/tasks/{taskId}Update task
DELETE/contacts/{contactId}/tasks/{taskId}Delete task
PUT/contacts/{contactId}/tasks/{taskId}/completedUpdate task completed
GET/contacts/{contactId}/appointmentsGet appointments for contact
POST/contacts/{contactId}/tagsAdd tags
DELETE/contacts/{contactId}/tagsRemove tags
GET/contacts/{contactId}/notesGet all notes
POST/contacts/{contactId}/notesCreate note
GET/contacts/{contactId}/notes/{id}Get note
PUT/contacts/{contactId}/notes/{id}Update note
DELETE/contacts/{contactId}/notes/{id}Delete note
POST/contacts/{contactId}/followersAdd followers
DELETE/contacts/{contactId}/followersRemove followers
POST/contacts/{contactId}/campaigns/{campaignId}Add contact to campaign
DELETE/contacts/{contactId}/campaigns/{campaignId}Remove contact from campaign
DELETE/contacts/{contactId}/campaigns/removeAllRemove contact from every campaign
POST/contacts/{contactId}/workflow/{workflowId}Add contact to workflow
DELETE/contacts/{contactId}/workflow/{workflowId}Delete contact from workflow
Last modified on March 5, 2026