Category: API, Technical Change, API-3409
Summary: Starting with an upcoming API deployment, PATCH updates to conversation participants for all conversation types will provide highly deterministic behavior. Previously, updating multiple fields on a participant may have incorrectly returned a successful response, whereas in reality one or more of the field updates failed.
For example, take a PATCH to api/v2/conversations/calls/{conversationId}/participants/{participantId} with a request body to modify the muted, held, and confined fields. In the past, muting could fail but the response status still indicate a success if the other two fields changed successfully. With this improvement, the aforementioned request would fail with an error message for the field(s) that failed to update.
The following APIs will be affected:
PATCH api/v2/conversations/{conversationId}/participants/{participantId}
PATCH api/v2/conversations/calls/{conversationId}/participants/{participantId}
PATCH api/v2/conversations/callbacks/{conversationId}/participants/{participantId}
PATCH api/v2/conversations/chats/{conversationId}/participants/{participantId}
PATCH api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}
PATCH api/v2/conversations/emails/{conversationId}/participants/{participantId}
PATCH api/v2/conversations/messages/{conversationId}/participants/{participantId}
PATCH api/v2/conversations/screenshares/{conversationId}/participants/{participantId}
PATCH api/v2/conversations/socials/{conversationId}/participants/{participantId}
PATCH api/v2/conversations/videos/{conversationId}/participants/{participantId}
Impact: Requests to these APIs without any failures will return responses per usual; there will be no noticeable change. Requests with one or more failures (client or server) will return a significantly more verbose error message containing details as to which field(s) failed to update and why.
Date of Change (on or after): 8/10/2018