August 28, 2026
· 6 min read
This release adds comprehensive support for lead source tracking across customer segments and reporting endpoints, enabling developers to filter and segment customers based on how they were acquired. Additionally, four new referral program endpoints have been introduced, allowing API consumers to programmatically access referral codes, generate QR codes, retrieve program details, and list referrals.
- GET /crm/customer_segments now returns lead source information in customer segment queries, enabling you to see how customers in each segment were acquired
- POST /crm/customer_segments now accepts lead source as a query criterion when creating segments, allowing you to build segments based on customer acquisition channels
- GET /crm/customer_segments/{id} now includes lead source in the segment query details returned
- PATCH /crm/customer_segments/{id} now returns lead source information in the updated segment response
- PUT /crm/customer_segments/{id} now returns lead source information in the updated segment response
- GET /platform/referral_code is a new endpoint that retrieves your referral code for sharing with potential referrals
- GET /platform/referral_code/qr_code is a new endpoint that generates a QR code for your referral link, making it easy to share in print or mobile contexts
- GET /platform/referral_program is a new endpoint that retrieves details about the referral program, including terms and rewards
- GET /platform/referrals is a new endpoint that lists all referrals you've made, allowing you to track referral status and rewards
- GET /reports/customers.grouped/data now supports filtering by lead source, enabling you to analyze grouped customer data by acquisition channel
- POST /reports/customers.grouped/export now accepts lead source as a filter when exporting grouped customer reports
- GET /reports/customers/data now supports filtering by lead source, allowing you to analyze customer data by how they were acquired
- POST /reports/customers/export now accepts lead source as a filter when exporting customer reports
GET /crm/customer_segments
- added the optional property
results/items/query/lead_sourceto the response with the200status (media type: application/json)
POST /crm/customer_segments
- added the new optional request property
query/lead_source(media type: application/json) - added the optional property
query/lead_sourceto the response with the201status (media type: application/json)
GET /crm/customer_segments/{id}
- added the optional property
query/lead_sourceto the response with the200status (media type: application/json)
PATCH /crm/customer_segments/{id}
- added the optional property
query/lead_sourceto the response with the200status (media type: application/json)
PUT /crm/customer_segments/{id}
- added the optional property
query/lead_sourceto the response with the200status (media type: application/json)
GET /platform/referral_code
- endpoint added
GET /platform/referral_code/qr_code
- endpoint added
GET /platform/referral_program
- endpoint added
GET /platform/referrals
- endpoint added
GET /reports/customers.grouped/data
- added the new optional
queryrequest parameterlead_source
POST /reports/customers.grouped/export
- added the new optional request property
lead_source(media type: application/json)
GET /reports/customers/data
- added the new optional
queryrequest parameterlead_source
POST /reports/customers/export
- added the new optional request property
lead_source(media type: application/json)