Profile API

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 NameMethodEndpointDescription
Update TimezonePATCH/v6/profile/timezoneUpdates the timezone setting for the authenticated user account.

Status Codes

Status CodeMeaningExample Response
200Success{ "message": "Profile updated successfully" }
400Bad Request{ "error": [{ "message": "Please provide a valid timezone", "field": "time_zone" }] }
401Unauthorized{ "error": "Unauthorized access. Please provide a valid API key." }
404Not Found – Unsupported timezone{ "error": "Timezone not found in supported list." }
500Internal Server Error{ "error": "An unexpected error occurred. Please try again later." }

Supported Timezones

TimezoneUTC Offset
Asia/Kolkata+05:30
America/New_York-05:00
Europe/London+00:00
Pacific/Tongatapu+13:00
Etc/UTC+00:00