Docs/Contact Management

Contact Management API

Create, list, and update contacts in TheQuickAssist. Phone numbers are normalized automatically to E.164 without '+', opt-in status is tracked, and pre-existing attributes can be assigned and modified.

Strict Creation

Rejects duplicates if a contact with the same phone number already exists (409 Conflict).

Search & Pagination

Query contacts by name or phone with customizable limit, page number, and sort order.

System Attributes

Assign and update custom attributes that are already registered in your chatbot workflow.

Quick Code Examples

1. List Contacts (with pagination & search)

curl -X GET "https://gateway-api.thequickassist.co/v1/contacts/list-contacts?page=1&limit=10&sortOrder=desc&search=Aarav" \
  -H "x-api-key: YOUR_API_KEY"

2. Add a New Contact

curl -X POST "https://gateway-api.thequickassist.co/v1/contacts/add-contact" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "919876543210",
    "name": "Jane Doe",
    "attributes": [
      { "attributeName": "city", "attributeValue": "Mumbai" }
    ]
  }'

3. Update an Existing Contact

curl -X PUT "https://gateway-api.thequickassist.co/v1/contacts/update-contact/6a991674fe0860eb4ee446c2" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Doe Updated",
    "attributes": [
      { "attributeName": "city", "attributeValue": "Delhi" }
    ]
  }'

Available Endpoints

Open Interactive Tester

Method	Path	Description	Try It
GET	/v1/contacts/list-contacts	Retrieve contacts with pagination, sorting, and search filtering.	Test
POST	/v1/contacts/add-contact	Create a new contact with pre-existing attributes.	Test
PUT	/v1/contacts/update-contact/:contactId	Update contact name, phone, or existing custom workflow attributes.	Test