Skip to main content
PUT
Update a contact group
SystemUser accessible. Required policy actions:
  • ContactGroupService:updateContactGroup

Authorizations

Authorization
string
header
required

JWT bearer token obtained from POST /auth/system-login using your client credentials.

Path Parameters

id
string
required

Contact group id.

Body

application/json
label
string
required

Display name for this contact.

Example:

"Billing team"

purpose
enum<string> | null

Which document type this contact is used for. null (or omitted) means a generic contact used for anything ("All"). Only one contact group is allowed per target + purpose combination.

Available options:
invoice,
credit_note,
dunning,
null
email
string<email>[]

Email address(es) this contact is reached at.

cc
string<email>[]

CC email address(es).

bcc
string<email>[]

BCC email address(es).

phoneNumber
string

Contact phone number.

Response

Success

status
string
Example:

"success"

message
string
Example:

"Success"

data
object | null

Endpoint-specific payload (object, array, or null)