1. Order
  2. Forget Contact

Forget Contact POST

URI

https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}
/order-service/order/forget-contact/{CONTACT-ID}

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

Description

Obfuscates contact details from orders. The contact's name will be replaced with the text "FORGOTTEN CONTACT" followed by the date and time the contact was forgotten. Use parameter keepCityAndState=true to keep city and state information (e.g. /order/forget-contact/{CONTACT-ID}?keepCityAndState=true).

Example 1

Requesting to forget contact information of contact with ID 200 within order details

Request URI

/order/forget-contact/200

Response

{
	"response": {
		"numberOfOrdersModified": 3
	}
}

Example 2

Requesting to forget contact information of contact that does not exist. The numberOfOrdersModified will be set to 0.

Request URI

/order/forget-contact/400

Response

{
	"response": {
		"numberOfOrdersModified": 0
	}
}