Skip to content

Custom Http Headers

Cardlytics Ad Server APIs support custom http headers for all endpoints.

Custom Headers

Header Description
X-CDLX-Session Client can send its customized client session id using this header and it is limited to 512 bytes, if exceed 512 bytes it will be automatically truncated to 512 bytes
X-CDLX-Meta Client can send its client metadata information using this header and it is limited to 512 bytes, if exceed 512 bytes it will be automatically truncated to 512 bytes

How these headers will be used:

  • Custom headers are optional. No back-compatible issue for old versions.
  • 'X-CDLX-Session' header is provided to help client to debugging the request failure since it will be embedded in the API response error message there if exception happens.
  • 'X-CDLX-Meta' header is provided to help client to have a place to send over more client specific meta info related to the request so it will be helpful for future investigation if needed.