Contact Group POST

URI

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

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

Description

This message allows you to create a new contact group. You can then add members to the group using Contact Group Member POST.

Field Name Field Description Required Minimum Length Maximum Length
name A short name for this group (Sales Team, Loyalty Card Members etc) Yes 4 64
description A short free-text description about this group (perhaps explaining the purpose of the group) No 0 255

Example

Create a new contact group for holding loyalty card members. The ID assigned to the group will be the only data included in the response.

Request URI

/contact-group

Request body

{
	"name": "Loyalty Card Members",
	"description": "All customers who have signed up for our loyalty scheme"
}

Response

{
	"response": 1000
}