PApaperlessparts
Integration Actions

Update fields on a managed integration

Update fields on a managed integration. Cannot update UUID or erp_name

patch/managed_integrations/public/{managed_integration_uuid}

Request

Path parameters

managed_integration_uuidstring required

The unique identifier for the managed integration to be returned

Request body

is_activeboolean

whether the integration is active

erp_namestring

The name of the ERP system being integrated with

erp_versionstring

The version of the ERP system being integrated with

integration_versionstring

The version of the codebase processing the integration

create_integration_action_after_creating_new_orderboolean

Whether a new integration action should be created after a new order is faciliated in Paperless

create_integration_action_after_quote_sentboolean

Whether a new integration action should be created after a new quote is sent in Paperless

Example request

{
  "is_active": true,
  "erp_name": "JobBOSS",
  "erp_version": "1.0",
  "integration_version": "1.0",
  "create_integration_action_after_creating_new_order": true,
  "create_integration_action_after_quote_sent": true
}

Response

Successful response

uuidstring
updatedstring date-time
authorstring

The creator of this integration

categorystring

The category of tool that this integration belongs to

configuration_parametersobject
descriptionstring

A short description for the integration

developed_by_paperless_partsboolean

A boolean reflecting whether the integration was created by Paperless Parts

erp_namestring
erp_versionstring
icc_setup_completeboolean
icc_ssh_tunnel_statusstring nullable
icc_ssh_tunnel_status_expirationstring date-time nullable
integrated_software_namestring

The name of the integration

integrated_software_versioninteger

1.0

integration_template_idinteger nullable
integration_versioninteger

1.0

internal_productized_namestring nullable
is_activestring

True

is_icc_compatibleboolean
is_icc_enabledboolean
locatorstring nullable
namestring

The name of the integration

release_channelstring
statusstring

Either 'up' or 'down', reflecting the health of the integration

support_contactstring

A contact to reach out to for support on this integration

Example response

{
  "author": "John Doe",
  "category": "ERP",
  "description": "Connecting other shop software to Paperless Parts",
  "developed_by_paperless_parts": true,
  "integrated_software_name": "JobBOSS²",
  "is_active": "Whether the integration is active",
  "name": "JobBOSS²",
  "status": "up",
  "support_contact": "support@paperlessparts.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.