Intercom API (unofficial showcase)
PATCH/data_connectors/{id}/versions/{version_id}

Update the note on a data connector version

Updates the note on a data connector version; no other version field can be changed. Send an empty or whitespace-only string to clear the note. This operation does not publish the version or roll the connector back, and it requires the read_write_data_connector_versions OAuth scope.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 parameters · 1 body field
idstringrequired
The unique identifier of the data connector.
version_idintegerrequired
The version's `entity_version_id`, returned when listing data connector versions.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

The note to set on the data connector version.

notestringrequired
The new note for the version. Sending `null`, an empty string, or a whitespace-only string clears the note.

4 status codes
200Returns the updated version snapshot, including its note and connector definition.
typestringoptional
The type of object - `data_connector_version`.
Allowed:data_connector_version
statusstringoptional
The status of this version today.
Allowed:livepauseddraftpreviously_live
notestringoptional
A note describing this version, if one has been set.
authorobjectoptional
The teammate who created this version.
created_atstringoptional
The time this version was created.
entity_version_idintegeroptional
The identifier of this version. Use it as `version_id` when retrieving or updating a version.
definitionobjectoptional
The data connector's configuration at this version. `null` if the snapshot is no longer available. Mirrors the response of [Retrieve a data connector](/docs/references/rest-api/api.intercom.io/data-connectors/retrievedataconnector), without `id`, `type`, `created_by_admin_id`, `updated_by_admin_id`, `created_at`, `updated_at`, `execution_results_url` and `transform_code_block`.
400Returned when a parameter or request value is invalid.

2 documented failures

  • parameter_not_found

    note parameter is required

  • parameter_invalid

    note must be a string

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthorized.

2 documented failures

  • unauthorized

    Access Token Invalid

  • token_unauthorized

    Not authorized to access resource

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the data connector or version is not found.

2 documented failures

  • data_connector_not_found

    Data connector not found

  • not_found

    Resource Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 400 is returned for an invalid request, a 401 when the request is unauthorized, and a 404 when the data connector or version is not found. The request body must include note; an empty or whitespace-only string clears it. The id path parameter must identify the data connector, and the version_id path parameter must identify its version.