Contact Note POST

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/contact-service/contact/{ID}/note

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

Description

This message enables you to add a contact note for an existing contact.

The response of the Contact Note POST represents the ID of the contact note in your Brightpearl system.

By adding a contact note to a contact record, you can record any external correspondence with that contact so that it’s visible on their timeline. This is especially useful if your business is using any email marketing or helpdesk solutions, as you’ll be able to use the external tools to manage your customers whilst keeping Brightpearl up to date for your colleagues.

When submitting a contact note, you can specify a specific time to associate with it. This is optional, as most apps will just want to record the note as ‘now’, however you can submit a past or present date if you need to. Be aware that if you submit a note with a future date, that note won’t be visible on the contacts timeline until that date has passed.

Field Description Required
text This is the text for the contact note. True
isPublic This represents the visibility of the contact note on the Brightpearl customer portal.

If this is not provided, it will default to false.

False
addedOn This represents the date on which the contact note was added.

If this is not provided, today's date will be used.

False

Example 1

Creating a new contact note for contact 1029.

Request URI

/contact/1029/note

Request body

{
	"text": "Contact note text"
}

Response

{
	"response": 97
}

Example 2

Creating a new contact note for contact 1030, specifying the date and visibility.

Request URI

/contact/1030/note

Request body

{
	"text": "Contact note text",
	"addedOn": "2014-06-29T11:12:24.000+01:00",
	"isPublic": false
}

Response

{
	"response": 60
}