Competitor Monitoring
Update Competitor
Update a competitor’s details, or pause and resume monitoring
PATCH
/
competitors
/
{id}
curl -X PATCH https://api.clustr-ai.com/api/public/competitors/c1a2b3c4-d5e6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "status": "paused" }'
curl -X PATCH https://api.clustr-ai.com/api/public/competitors/c1a2b3c4-d5e6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "company_name": "Globex Corporation" }'
{
"success": true,
"data": {
"id": "c1a2b3c4-d5e6-7890-abcd-ef1234567890",
"company_name": "Globex Inc",
"domain": "globex.com",
"linkedin_url": "https://www.linkedin.com/company/globex",
"status": "paused",
"created_at": "2026-06-30T09:00:00Z",
"updated_at": "2026-06-30T10:42:00Z"
}
}
{
"success": false,
"error": { "message": "Competitor not found", "code": "NOT_FOUND" }
}
{
"success": false,
"error": {
"message": "Competitor monitoring slot limit reached",
"code": "CONFLICT"
}
}
Update a competitor’s details or status. Send only the fields you want to change.
Set
status to paused to stop monitoring without deleting the competitor; paused competitors free their slot. Flipping paused back to active is subject to the slot limit and returns 409 when full.
Path
string
required
Competitor ID.
Body
string
string
string
string
active or paused.curl -X PATCH https://api.clustr-ai.com/api/public/competitors/c1a2b3c4-d5e6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "status": "paused" }'
curl -X PATCH https://api.clustr-ai.com/api/public/competitors/c1a2b3c4-d5e6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "company_name": "Globex Corporation" }'
{
"success": true,
"data": {
"id": "c1a2b3c4-d5e6-7890-abcd-ef1234567890",
"company_name": "Globex Inc",
"domain": "globex.com",
"linkedin_url": "https://www.linkedin.com/company/globex",
"status": "paused",
"created_at": "2026-06-30T09:00:00Z",
"updated_at": "2026-06-30T10:42:00Z"
}
}
{
"success": false,
"error": { "message": "Competitor not found", "code": "NOT_FOUND" }
}
{
"success": false,
"error": {
"message": "Competitor monitoring slot limit reached",
"code": "CONFLICT"
}
}
⌘I
curl -X PATCH https://api.clustr-ai.com/api/public/competitors/c1a2b3c4-d5e6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "status": "paused" }'
curl -X PATCH https://api.clustr-ai.com/api/public/competitors/c1a2b3c4-d5e6-7890-abcd-ef1234567890 \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "company_name": "Globex Corporation" }'
{
"success": true,
"data": {
"id": "c1a2b3c4-d5e6-7890-abcd-ef1234567890",
"company_name": "Globex Inc",
"domain": "globex.com",
"linkedin_url": "https://www.linkedin.com/company/globex",
"status": "paused",
"created_at": "2026-06-30T09:00:00Z",
"updated_at": "2026-06-30T10:42:00Z"
}
}
{
"success": false,
"error": { "message": "Competitor not found", "code": "NOT_FOUND" }
}
{
"success": false,
"error": {
"message": "Competitor monitoring slot limit reached",
"code": "CONFLICT"
}
}