External Contacts: change to /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}

Category: API

Summary: The PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId} endpoint that links a trustor with an external organization will return an ExternalOrganizationTrustorLink that includes an externalOrganizationUri URI allowing one to GET the updated external organization that includes all trustors -- including the one just added by the PUT.

Context: Genesys Cloud REST PUT endpoints generally return a selfUri referencing the modified resource. This endpoint links a Trustor with an External Organization representing a trust relationship between the two. Since it creates a relationship, the PUT returns a representation of the relationship with a selfUri.

However there is no endpoint for returning these relationship themselves. Instead, we think this endpoint should return a resource reference to the external organization including all of its trustors.

Impact: There is no fundamental change in behavior, but this is a change for SDKs in terms of the response. The current response returns selfUri for the trustor organization but there is no GET endpoint for that trustor organization. Rather, the newer response will return an externalOrganizationUri for the External Organization that can be used to retrieve the organization and all of its trustors.

Date of Change: On or after August 21, 2020

Impacted APIs: External Contacts API

References: RELATE-3314

This topic was automatically closed 62 days after the last reply. New replies are no longer allowed.