Introduction

Read, update, and delete customer records used for conversion attribution.

Overview

  • (GET) Retrieve customers by ID or external ID with pagination support
  • (PUT) Update existing customers by ID or external ID
  • (DELETE) Soft-delete customers by ID
  • Automatic customer creation/updates through conversion tracking endpoints
  • Support for filtering and sorting to efficiently find specific customers

The Customers API provides access to customer data used for conversion attribution and customer management workflows. Direct customer writes can update or soft-delete existing customers, but this API does not create customers.

When you track a lead or sale event using the conversion tracking endpoints (/api/track/lead or /api/track/sale), Hoko automatically creates or updates the customer record based on the customerExternalId. This ensures your customer data stays in sync with your conversion tracking activities.

Use the Customers API to retrieve customer information, update existing customer profile fields, verify customer existence, build customer management interfaces, or integrate customer data with other systems. The API supports filtering by customer ID or external ID, making it easy to find specific customers.

Customer Management

Use `customersRead` for retrieval and `customersWrite` for direct updates or deletion. Customer creation remains part of conversion tracking through the `conversionsWrite` scope.