Update an integration

PATCH

Update a platform integration. Note: only integrations in development may be updated. Integrations submitted for publication cannot be updated.

Path parameters

idstringRequired

The id of the platform integration to update

Request

This endpoint expects an object.
authorstringOptional>=1 character<=160 characters

The name of the integration developer

call_to_actionstringOptional>=1 character

The call to action text

configuration_fieldsmap from strings to anyOptional

A json-schema describing the settings fields that a user should be presented with when installing the integration

contactstringOptional>=1 character

The URL or email address where users of the integration can reach out for support

descriptionstringOptional>=1 character

A description of what the integration does and how to use it

error_codesmap from strings to anyOptional

An object containing error codes and their corresponding error message the integration may return to the OAuth failure page to be displayed

identifier_field_pathstringOptional

JMESPath describing which of the fields in configuration_fields is the best human-friendly field to use to identify a specific installation (e.g., account name)

namestringOptional>=1 character<=160 characters

The name of the integration

oauth_callback_urlstringOptional>=1 character

The get endpoint that will be invoked after OAuth authorization

scopeslist of stringsOptional

The list of OAuth token permissions the integration requests when installed

tagslist of "knowledge"Optional

A list of tags that describe the type of integration

uninstallation_urlstringOptional>=1 character

The delete endpoint that initiates the uninstallation flow for the integration

Response

Platform integration updated

idstring

The unique identifier for the integration

identifier_field_pathstring

JMESPath describing which of the fields in configuration_fields is the best human-friendly field to use to identify a specific installation (e.g., account name)

statusstring

The current state of the integration (development, approved, archived)

authorstringOptional>=1 character<=160 characters

The name of the integration developer

call_to_actionstringOptional>=1 character

The call to action text

configuration_fieldsmap from strings to anyOptional

A json-schema describing the settings fields that a user should be presented with when installing the integration

contactstringOptional>=1 character

The URL or email address where users of the integration can reach out for support

createddatetimeOptional

The date the integration was created

descriptionstringOptional>=1 character

A description of what the integration does and how to use it

error_codesmap from strings to anyOptional

An object containing error codes and their corresponding error message the integration may return to the OAuth failure page to be displayed

namestringOptional>=1 character<=160 characters

The name of the integration

oauth_callback_urlstringOptional>=1 character

The get endpoint that will be invoked after OAuth authorization

scopeslist of stringsOptional

The list of OAuth token permissions the integration requests when installed

tagslist of "knowledge"Optional

A list of tags that describe the type of integration

uninstallation_urlstringOptional>=1 character

The delete endpoint that initiates the uninstallation flow for the integration

updateddatetimeOptional

The date the integration was last updated

Get an installation
Built with