Skip to main content
PUT
/
api
/
contact-metrics
/
config
Update category configuration
curl --request PUT \
  --url https://your-instance.example.com/api/contact-metrics/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "categories": [
    {
      "name": "New",
      "key": "new",
      "statuses": [
        "new"
      ],
      "color": "#3B82F6"
    },
    {
      "name": "Working",
      "key": "working",
      "statuses": [
        "qualified",
        "in-progress"
      ],
      "color": "#10B981"
    },
    {
      "name": "Closed",
      "key": "closed",
      "statuses": [
        "won",
        "lost"
      ],
      "color": "#6B7280"
    }
  ],
  "allowMultipleCategories": false
}
'
{
  "success": true,
  "data": {
    "categories": [
      {
        "name": "New",
        "key": "new",
        "statuses": [
          "new"
        ],
        "color": "#3B82F6"
      },
      {
        "name": "Working",
        "key": "working",
        "statuses": [
          "qualified",
          "in-progress"
        ],
        "color": "#10B981"
      }
    ],
    "allowMultipleCategories": false,
    "defaultMetricsPipelineId": "66f0a0b0c0d0e0f0a0b0c0d0"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
categories
object[]
required

Category definitions used to bucket contacts on the analytics dashboard.

allowMultipleCategories
boolean

When true, a contact can fall under more than one category at the same time.

pipelineId
string

Pipeline _id the categories apply to.

Response

Metrics config updated

success
enum<boolean>
required
Available options:
true
data
object
required

Updated Organization.contactMetricsConfig document.