Last updated

Contacts

Contacts are the core relationship of the CRM for Reps. They're how all pre-sales activity is tracked. On the Contact card, all related Activities, Notes, and Tasks show up, giving reps a complete view of their relationship with each person.


Rules

  • Contacts belong to a User and are not accessible by the Company unless the Contact was created on the Company's website or via the Company API
  • Contacts can be associated to Groups created by the User to organize their Contacts
  • Contacts can be shared products, media, enrollments, playlists, categories, collections, and posts via a SmartLink that tracks their activity on the Company site and sends push notifications for activity

JSON Structure

{
  "id": 12345,
  "company_id": null,
  "token": "abc123def456",
  "first_name": "Jane",
  "last_name": "Smith",
  "full_name": "Jane Smith",
  "email": "jane.smith@example.com",
  "email2": null,
  "phone": "+1-555-123-4567",
  "phone2": null,
  "phone_id": null,
  "avatar_url": "https://example.com/avatars/jane.jpg",
  "status": "active",
  "address": "123 Main Street",
  "address2": "Apt 4B",
  "city": "Austin",
  "state": "TX",
  "postal_code": "78701",
  "country_id": 1,
  "language_id": 1,
  "lead_type": "warm",
  "ip": "192.168.1.1",
  "requested_at": "2025-01-10T08:00:00Z",
  "best_time": "morning",
  "time_zone": "America/Chicago",
  "reason": "Interested in products",
  "income": null,
  "hours": null,
  "invest": null,
  "interest": "health products",
  "discarded_at": null,
  "metadata": {}
}

API Endpoints

Company Scoped

Note: Company scoped endpoints will only return Contacts created on the Company's website or via the Company API. User-created Contacts are not accessible.

VerbEndpointDescription
GET/api/company/crm/v202506/contactsList all company contacts
GET/api/company/crm/v202506/contacts/:idGet a specific contact
POST/api/company/crm/v202506/contactsCreate a new contact
PATCH/api/company/crm/v202506/contacts/:idUpdate a contact
DELETE/api/company/crm/v202506/contacts/:idDelete a contact

User Scoped

VerbEndpointDescription
GET/api/user/crm/v202506/contactsList user's contacts
GET/api/user/crm/v202506/contacts/:idGet a specific contact
POST/api/user/crm/v202506/contactsCreate a new contact
POST/api/user/crm/v202506/contacts/bulkBulk create multiple contacts
PATCH/api/user/crm/v202506/contacts/:idUpdate a contact
DELETE/api/user/crm/v202506/contacts/:idDelete a contact

Next Steps