Management API: Options Object Overwritten when Trying to Update a Connection

Overview

When updating the options parameter via the API, the response only includes the updated values provided. However, due to this parameter’s overwrite behavior, certain existing parameters are removed in some cases. This article explains how to update this value correctly.

Applies To

  • Patch a Connection

Cause

This is the expected behavior.

Solution

It is by design that when using the options parameter for the entire options object to be overridden. All parameters need to be added before patching, not just the new values.

Use Get a Connection before trying to Patch a connection to retrieve all parameters to avoid overwriting the options object they are trying to update with the default parameters.