Skip to content
ClickFix
Sign inBook a demo
Documentation

Send a company usage signal

View as MarkdownOpen in ChatGPTOpen in ClaudeFeedback
PUT
/v1/public-api/company-usage

Scope: health:write. A 0–100 usage signal from your own product; it counts towards the customer-health score for 30 days. The company is found by company_uuid, external_id or domain. Idempotency-Key is required.

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organization API key (cf_sk_…), created under Organization → API and automations → API keys and sent as Authorization: Bearer cf_sk_….

Header Parameters

Idempotency-Key*string
Lengthlength <= 200

Request Body

application/json
  1. body
company_uuid?string
Formatuuid
external_id?string
domain?string
score*integer
Range0 <= value <= 100

Response Body

OK

application/json
  1. response
success*true
Value intrue
data*
meta*
Example Request
curl -X PUT 'https://api.getclickfix.com/v1/public-api/company-usage' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "external_id": "F-77",  "score": 90}'
Example Response
{  "success": true,  "data": {    "company_uuid": "0f9e8d7c-6b5a-4493-8271-605f4e3d2c1b",    "score": 90,    "expires_at": "2026-12-11T09:30:00Z"  },  "meta": {    "request_id": "01JCK9ZQ3M8R2W7X5E4T1N0PAB"  }}