Preferred Response Date Format Header

Overview

The X-Preferred-Response-Datetime-Format header enables developers to customize the format of date attributes in API responses to meet their specific needs and system requirements. This flexibility ensures that date and time values are returned in a format that is both easily readable and compatible with various programming languages and platforms. It is especially beneficial for developers handling internationalization, allowing them to choose formats with time zone information or region-specific conventions. By offering multiple datetime formats, the API enhances usability and integration across diverse environments.

For webhook events and payloads, datetime attributes will always be sent in UNIX timestamp format, regardless of the X-Preferred-Response-Datetime-Format header. This approach maintains consistency across all webhook payloads, ensuring that developers can reliably parse and handle date and time values without needing to account for multiple formats. By standardizing the datetime format for webhooks, the API simplifies integration and reduces potential errors, making it easier for developers to work with event-driven architectures.

Supported Date Formats

ISO 8601

A standard, human-readable format that includes time zone information, widely used and supported across various platforms and programming languages (e.g, 2024-08-04T14:22:01Z).

Unix Timestamp

A numerical representation of the number of milliseconds since the UNIX epoch January 1, 1970, 00:00:00 UTC , ensuring high precision. Commonly used in systems where high precision and compact representation are required (e.g, 1722572118554).