Learn how to use Profile API V6.
Overview
The Profile API enables users to manage account-level settings, primarily focusing on timezone preferences. This ensures that all logs, reports, and activity timestamps are aligned with the user's local time.
Authentication
All requests must include an API key passed via the Authorization
header:
Authorization: Bearer <api_key>
Available Endpoints
Endpoint Name | Method | Endpoint | Description |
---|---|---|---|
Update Timezone | PATCH | /v6/profile/timezone | Updates the timezone setting for the authenticated user account. |
Status Codes
Status Code | Meaning | Example Response |
---|---|---|
200 | Success | { "message": "Profile updated successfully" } |
400 | Bad Request | { "error": [{ "message": "Please provide a valid timezone", "field": "time_zone" }] } |
401 | Unauthorized | { "error": "Unauthorized access. Please provide a valid API key." } |
404 | Not Found – Unsupported timezone | { "error": "Timezone not found in supported list." } |
500 | Internal Server Error | { "error": "An unexpected error occurred. Please try again later." } |
Supported Timezones
Timezone | UTC Offset |
---|---|
Asia/Kolkata | +05:30 |
America/New_York | -05:00 |
Europe/London | +00:00 |
Pacific/Tongatapu | +13:00 |
Etc/UTC | +00:00 |