1663832908583941.png)
Built with DocStarTo help you efficiently track and correlate your API requests, we support optional metadata parameters that can be passed in your request payload. These values are returned as-is in delivery reports and webhook callbacks (where supported), enabling seamless mapping with your internal systems.
1. clientId
Purpose:
Allows you to receive the same clientId in webhook callbacks, helping you associate responses with your original request.Availability:
Supported only in Webhook v2.Usage:
Can be passed either as a top-level parameter or within a metadata object.
This parameter is not validated by our system (for backward compatibility).
2. CRQID
Purpose:
Enables request-level tracking for reconciliation in delivery reports and webhook callbacks.Availability:
Supported in all versions of webhook and delivery reports.Usage by Request Type:
Request Type | Usage Instructions |
Bulk / Single | Pass one CRQID at the top level of the request (outside the recipients array). |
Advance | Pass a unique CRQID for each recipient, inside each entry of the recipients array. |
3. UUID
Purpose:
Functions the same as CRQID for request tracking and correlation.Availability:
Supported in all versions of webhook and delivery reports.Usage:
Follows the same structure and rules as CRQID for Bulk, Single, and Advance request types.
Summary Table
Parameter | Purpose | Webhook Support | Delivery Report Support |
clientId | Identifies the request in webhooks | Webhook v2 only | ❌ Not returned in reports |
CRQID | Tracks and correlates API requests | All versions | ✅ Yes |
UUID | Alternative to CRQID for tracking | All versions | ✅ Yes |
Notes
Allowed characters for CRQID and UUID:
Alphanumeric + _ (underscore), . (dot), - (hyphen)In case, you use CleverTap, CRQID will be received in Metadata and UUID will be received in UUID field only.
Maximum length:
80 characters