Custom Metadata Parameters for Tracking Requests

To help you efficiently track and correlate your SMS 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:

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

Notes

• Allowed characters for CRQID and UUID:
  Alphanumeric + _ (underscore), . (dot), - (hyphen)

• Maximum length:
  80 characters