Contact Group PUT

URI

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

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

Description

This message allows you to update an existing contact group. You may either rename the contact group or update its description.

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

Update contact group 57.

Request URI

/contact-group/57

Request body

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

Response

{
}