Genesys Cloud - Developer Announcements!

 View Only

Sign Up

  • 1.  [Update] Public API Response Update: "timeZone" Field Format Change

    Posted 20 days ago
    Edited by Ananya Singh 9 days ago

    Summary

    New rollout date : on & after 31st August 2026 (Based on customer feedback and impact considerations, we are extending the rollout timeline to allow customers additional time for planning, validation, and adoption activities prior to the change taking effect.)

    Following the previously postponed rollout, the Public API is moving forward with an update to align time zone formatting with the modern IANA time zone identifier convention.

    This change replaces the older Olson-style short format with the current IANA format to improve accuracy and reflect modern time zone standards, including changes in daylight savings observance across different regions.

    For example:

    • Previous format: EST5EDT
    • New format: America/New_York

    Effective Date

    Monday, June 8, 2026

    Monday, August 31, 2026

    Details

    Date and time formatting standards are continually evolving. To provide a better user experience and maintain accuracy, we are updating our API to follow the modern IANA time zone identifier format. This standard moves away from the shorter, original time zone formats.

    You can find the latest IANA tz database information here: Time Zone database

    Customer Impact

    Customers consuming API responses will observe a change in the format of the timeZone response fields. Time zones will now be represented by city name instead of the previous short format.

    For example, EST5EDT will now appear as America/New_York in API responses.

    Users who rely on the previous short format may need to adjust their applications to accommodate this change.

    Impacted Resources

    The following APIs will be affected by this change in the timeZone field within their responses:

    /api/v2/telephony/providers/edges/timezones

    /api/v2/timezones

    /api/v2/gamification/contests

    /api/v2/gamification/contests/{contestId}

    /api/v2/gamification/scorecards/users/values/average

    /api/v2/gamification/scorecards/values/trends

    /api/v2/gamification/scorecards/users/{userId}/values/trends

    /api/v2/gamification/scorecards/users/values/trends

    /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends

    /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends

    /api/v2/analytics/actions/aggregates/jobs

    /api/v2/analytics/actions/aggregates/query

    /api/v2/analytics/agentcopilots/aggregates/query

    /api/v2/analytics/flows/aggregates/query

    /api/v2/quality/evaluations/aggregates/query/me

    /api/v2/analytics/bots/aggregates/query

    /api/v2/analytics/bots/aggregates/jobs

    /api/v2/analytics/conversations/aggregates/jobs

    /api/v2/analytics/conversations/aggregates/query

    /api/v2/analytics/flowexecutions/aggregates/query

    /api/v2/analytics/flowexecutions/aggregates/jobs

    /api/v2/analytics/flows/aggregates/query

    /api/v2/analytics/flows/aggregates/jobs

    /api/v2analytics/journeys/aggregates/query

    /api/v2/analytics/journeys/aggregates/jobs

    /api/v2/analytics/ratelimits/aggregates/query

    /api/v2/analytics/resolutions/aggregates/query

    /api/v2/analytics/resolutions/aggregates/jobs

    /api/v2/analytics/summaries/aggregates/query

    /api/v2/analytics/summaries/aggregates/jobs

    /api/v2/analytics/surveys/aggregates/query

    /api/v2/analytics/surveys/aggregates/jobs

    /api/v2/analytics/taskmanagement/aggregates/jobs

    /api/v2/analytics/taskmanagement/aggregates/query

    /api/v2/quality/evaluations/aggregates/query/me

    /api/v2/analytics/transcripts/aggregates/query

    /api/v2/analytics/transcripts/aggregates/jobs

    /api/v2/analytics/users/aggregates/query

    /api/v2/analytics/users/aggregates/jobs

    /api/v2/outbound/schedules/campaigns

    /api/v2/outbound/schedules/campaigns/{campaignId}

    /api/v2/outbound/schedules/sequences

    /api/v2/outbound/schedules/sequences/{sequenceId}

    /api/v2/outbound/schedules/messagingcampaigns

    /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}

    /api/v2/outbound/schedules/emailcampaigns

    /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}

    /api/v2/outbound/schedules/whatsappcampaigns

    /api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}

    /api/v2/outbound/contactlists/{contactListId}/contacts/search

    /api/v2/outbound/contactlistfilters/preview

    /api/v2/outbound/campaigns/{campaignId}/callback/schedule

    /api/v2/outbound/contactlists/{contactListId}/contacts

    /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}

    /api/v2/outbound/contactlists/{contactListId}/contacts/bulk

    /api/v2/outbound/callabletimesets

    /api/v2/outbound/callabletimesets/{callableTimeSetId}

    /api/v2/outbound/settings

    /api/v2/outbound/attemptlimits

    /api/v2/outbound/attemptlimits/{attemptLimitsId}

    /api/v2/architect/schedulegroups

    /api/v2/architect/schedulegroups/{scheduleGroupId}

    /api/v2/scim/v2/groups

    /api/v2/scim/v2/users

    /api/v2/scim/v2/users/{userId}

    /api/v2/scim/v2/groups/{groupId}

    /api/v2/socialmedia/analytics/aggregates/jobs

    /api/v2/socialmedia/analytics/messages/jobs

    /api/v2/workforcemanagement/teams/{teamId}/adherence/historical

    /api/v2/workforcemanagement/managementunits/{managementUnitId }/historicaladherencequery

    /api/v2/workforcemanagement/adherence/historical

    /api/v2/analytics/knowledge/aggregates/jobs

    /api/v2/analytics/knowledge/aggregates/query

    Issue References

    PURE-6863

    Contacts

    @Ananya Singh  

    Please reply to this announcement with any questions. This helps the wider developer community benefit from the discussion. We encourage you to use this thread before contacting the designated person directly. Thank you for your understanding.



  • 2.  RE: [Update] Public API Response Update: "timeZone" Field Format Change

    Posted 15 days ago

    Can I just get a clarification, this mentions the timezone field in the response will be in different format.

    At least for 

    /api/v2/analytics/conversations/aggregates/jobs

    /api/v2/analytics/conversations/aggregates/query

    timezone is an input, but not in the response schema anywhere.

    Is this primarily the Input, or the Response that is changing?

    And just confirming the actual datetime value is not changing at all?



    ------------------------------
    Anton Vroon
    ------------------------------



  • 3.  RE: [Update] Public API Response Update: "timeZone" Field Format Change

    Posted 2 days ago
    • The change affects timezone ID representation where timezone values are exposed or accepted.
    • The actual datetime values returned by the APIs are not changing.

    For the APIs listed by you - 

    • Legacy IDs are silently mapped

    • No visible request or response changes for clients



    ------------------------------
    Ananya Singh
    Senior Product Manager
    ------------------------------



  • 4.  RE: [Update] Public API Response Update: "timeZone" Field Format Change
    Best Answer

    Posted 2 days ago
    Edited by Ananya Singh 2 days ago

    Impacted APIs

    High Impact – Time Zone Listing APIs

    These APIs return lists of available time zone identifiers. Legacy short-form identifiers may no longer be returned and canonical IANA identifiers will be provided instead.

    API Method Impact
    /api/v2/timezones GET Returned time zone identifiers will use canonical IANA values. Legacy identifiers such as EST, MST, HST, EST5EDT, CST6CDT, MST7MDT, and PST8PDT may no longer appear in the response.
    /api/v2/telephony/providers/edges/timezones GET Same behavior as /api/v2/timezones.

    Customer impact: Applications that consume available time zone lists may need to update validation logic and stored mappings to use IANA time zone identifiers.


    Medium Impact – APIs Returning Time Zone Identifiers

    These APIs accept and/or return time zone identifiers. Legacy identifiers supplied in requests will continue to be accepted, but responses may return canonical IANA identifiers instead.

    Outbound Scheduling APIs
    API Methods
    /api/v2/outbound/schedules/campaigns GET
    /api/v2/outbound/schedules/campaigns/{campaignId} GET, PUT, DELETE
    /api/v2/outbound/schedules/sequences GET
    /api/v2/outbound/schedules/sequences/{sequenceId} GET, PUT, DELETE
    /api/v2/outbound/schedules/messagingcampaigns GET
    /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId} GET, PUT, DELETE
    /api/v2/outbound/schedules/emailcampaigns GET
    /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId} GET, PUT, DELETE
    /api/v2/outbound/schedules/whatsappcampaigns GET
    /api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId} GET, PUT, DELETE
    Outbound Contact, Rules, and Settings APIs
    API Methods
    /api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview GET
    /api/v2/outbound/contactlists/{contactListId}/contacts GET, POST
    /api/v2/outbound/contactlists/{contactListId}/contacts/search POST
    /api/v2/outbound/settings GET, PUT
    /api/v2/outbound/rulesets GET, POST
    /api/v2/outbound/rulesets/{ruleSetId} GET, PUT, DELETE
    /api/v2/outbound/digitalrulesets GET, POST
    /api/v2/outbound/digitalrulesets/{digitalRuleSetId} GET, PUT, DELETE
    /api/v2/outbound/callabletimesets GET, POST
    /api/v2/outbound/callabletimesets/{callableTimeSetId} GET, PUT
    /api/v2/outbound/attemptlimits GET, POST
    /api/v2/outbound/attemptlimits/{attemptLimitsId} GET, PUT
    Gamification APIs
    API Methods
    /api/v2/gamification/scorecards/values/trends GET
    /api/v2/gamification/scorecards/values/average GET
    /api/v2/gamification/scorecards/users/{userId}/values/trends GET
    /api/v2/gamification/scorecards/users/{userId}/values/average GET
    /api/v2/gamification/scorecards/users/{userId}/attendance GET
    /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends GET
    /api/v2/gamification/contests POST
    /api/v2/gamification/contests/{contestId} GET, PUT
    Architect APIs
    API Methods
    /api/v2/architect/schedulegroups GET, POST
    /api/v2/architect/schedulegroups/{scheduleGroupId} GET, PUT, DELETE
    Workforce Management APIs
    API Methods
    /api/v2/workforcemanagement/businessunits/{businessUnitId} GET
    /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules GET, POST
    /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules GET, POST

    Customer impact: Applications that compare, validate, or store time zone identifiers returned by these APIs may observe different values in responses and should support canonical IANA identifiers.


    No expected customer impact – APIs Accepting Time Zone Identifiers

    These APIs accept time zone identifiers in request payloads. Legacy identifiers will continue to be accepted and automatically mapped to canonical IANA identifiers. No request format changes are required.

    Analytics and Reporting APIs

    • /api/v2/analytics/*/aggregates/query
    • /api/v2/quality/evaluations/aggregates/query/me
    • /api/v2/analytics/reporting/exports
    • /api/v2/analytics/reporting/exports/{exportId}
    • /api/v2/analytics/reporting/schedules

    Audit APIs

    • /api/v2/orgauthorization/trustees/audits
    • /api/v2/orgauthorization/trustor/audits
    • /api/v2/quality/conversations/{conversationId}/audits/query
    • /api/v2/quality/calibrations

    Customer impact: No expected customer impact. Existing time zone identifiers will continue to be accepted.


    No Impact

    APIs that use date/time parsing and serialization but do not perform time zone identifier lookups are unaffected by this change. This includes:

    • SCIM APIs
    • Conversation APIs
    • Recording APIs
    • WEM Coaching APIs
    • WEM Learning APIs
    • WEM Development APIs

    No changes are required for integrations using these APIs.
    ------------------------------
    Ananya Singh
    Senior Product Manager
    ------------------------------