Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

External Contacts API Documentation Update – Removal of Unused Fields

  • 1.  External Contacts API Documentation Update – Removal of Unused Fields

    Posted 19 days ago

    Summary

    The External Contacts team is correcting a documentation issueby removing the id and selfUri fields from several API contracts. These fields have never returned any data at runtime for the affected objects, and their removal does not change API behavior.

    This update affects:

    • Developer Center documentation

    • Genesys Cloud API SDKs

    Effective Date

    Thursday, January 15, 2026

    Details

    Change Context

    The affected objects are not directly addressable resources in the API. They exist only within request and response bodies and therefore do not expose valid id or selfUri values. Removing these fields improves documentation accuracy and SDK correctness.

    Change Impact

    No runtime behavior is impacted.

    The only anticipated customer impact is for scripts or applications that consume the Genesys Cloud API SDKs and explicitly reference the removed fields. In such cases, customers can update their code by replacing references to these fields with expressions that return null.

    Fields Being Removed

    ContactIdentifier

    • Removed fields: id, selfUri

    • Reason: These records are not directly addressable via the API.

    • Affected APIs:

    • GET /api/v2/externalcontacts/contacts/{contactId}/identifiers

    • PATCH /api/v2/externalcontacts/contacts/{contactId}/identifiers

    • Any GET of External Contact(s) using ?expand=identifiers

    ExternalOrganizationIdentifier

    • Removed fields: id, selfUri

    • Reason: Same as ContactIdentifier; records are not directly addressable.

    • Affected APIs:

    • GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers

    • PATCH /api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers

    • Any GET of External Organization(s) using ?expand=identifiers

    ExternalOrganizationTrustorLink

    • Removed fields: id, selfUri

    • Reason: These records represent links between multiple Genesys customer organizations and do not have their own addressable identifier.

    Issue References

    RELATE-19646

    Contacts

    @Melody Griesen  

    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.



Related Content