Integration Instance PUT

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/integration-service/integration/instance

Refer to our documentation on URI syntax for more information on how to construct URIs.

Description

This endpoint allows you to update your own installed integration instance. It uses the token passed in the Authorization header (OAuth) or brightpearl-instance-token header (instance auth) and modifies the associated instance.

Currently, only the instanceName field can be updated.

Example

Update the instance associated with your authorization token

Request URI

/integration/instance

Request body

{
	"instanceName": "My new instance name"
}

Response

{
	"response": {
		"installedIntegrationInstanceId": 3,
		"installedIntegrationId": 13,
		"instanceName": "My new instance name"
	}
}