Updates the Destination configuration for the specified destination_id. The available settings depend on the Destination type. To retrieve the settings that your Destination currently uses, call the Get Details of a Destination endpoint. To retrieve every setting that the connector accepts, along with its data type and whether it is required, call the Get Configuration Details of a Destination Connector endpoint.
In the request body, send only the values that you want to change. Hevo keeps the current value of every field and config key that you do not send. When you change the configuration settings, Hevo tests the connection before it saves the change, and the call returns once the test finishes. If the test fails, the request returns a 400 and nothing is saved. A change to only the name is saved without a connection test. Leave out the credentials that you do not want to change. If you send back the masked value (********) that a read returns for a credential, Hevo tests the connection with that value, so the test fails and the request returns a 400.
Note: If you cannot send a PATCH request, send the same request body to the Modify Destination Configuration (POST) endpoint.
Refer to Modifying a Destination for more information about which settings you can change and how the change is applied.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
The Destination could not be updated. This occurs when:
- The request body is missing.
- The body sends no
nameand no non-emptyconfig. - The
namedoes not follow the naming rules. - The
nameis longer than 255 characters. - Another Destination already uses the
name. - The
configobject sends a setting that cannot be changed, or a value that fails validation. - The connection test fails.
Hevo does not check whether the values you send differ from the stored ones, so sending the current name, or a config that changes nothing, is accepted.
You do not have the permission to modify a Destination. Ask your team administrator for a role that allows it.
The Destination could not be found. This occurs when:
- No Destination exists with the specified
destination_id, or you do not have access to it. - The Destination is deleted, or its deletion is in progress.
- The Destination is in a different region from the base URL that you call.
Hevo could not complete the request. If the connection test is still running after five minutes, nothing is saved. The response returns an error_reference_id value that you can quote to Hevo Support.