Skip to main content
PATCH

Authorizations

x-api-key
string
header
required

The Minerva API key used for this integration. Manage API keys in the Minerva dashboard under Administration > Developers.

Path Parameters

profileGroupId
string
required

The Minerva-generated profile group ID.

Body

application/json

Profile group update request

name
string

Customer-facing profile group label.

Example:

"High Risk"

description
string

Optional description of the population this group represents. Send an empty string to clear it.

Example:

"Enhanced diligence customers requiring the most frequent monitoring."

priority
integer

Non-negative priority used to resolve profiles assigned to multiple groups. Active groups in the same workspace must use unique priorities.

Required range: x >= 0
Example:

100

archived
boolean

Set to true to archive the group, or false to restore it.

Example:

false

monitoringFeedFrequencies
object

Optional monitoring cadence overrides for profiles assigned to this group. Omitted feed keys inherit the workspace-level cadence.

Example:

Response

200 - application/json

Profile group updated successfully

message
string
Example:

"Profile Group Retrieved Successfully"

result
object