NotiQNotiQ API
API key
On this page

POST/campaigns/:id/overview-goal

Set or clear a campaign’s overview goal (the tag counted by the Performance chip).

0 credits. Rate class: campaign_control (default 20/min).

Request

POST /campaigns/:id/overview-goal
X-API-Key: sk_live_...
Content-Type: application/json

{ "tag": "Meeting booked" }
  • tag is required. null (or a blank string) clears the goal.
  • Built-ins: Interested, Meeting booked (case-insensitive). Do not send "Meetings". Do not send Meeting request (classifier alias only).
  • Anything else must be an active custom reply tag. Unknown or archived → 400.
curl -sS -X POST -H "X-API-Key: $KEY" -H "Content-Type: application/json" \
  -d '{"tag":"Meeting booked"}' \
  "https://api.notiq.io/public/v1/campaigns/$CAMPAIGN_ID/overview-goal"

Response

{
  "campaignId": "abc",
  "tag": "Meeting booked",
  "unchanged": false,
  "goalCount": 3,
  "leadsMessaged": 40,
  "goalRate": 7.5,
  "meetingsBooked": 3
}
FieldNotes
goalCountLeads whose current tag equals the goal
goalRategoalCount / leadsMessaged * 100 (capped at 100), 1 decimal; null when cleared or nobody messaged
meetingsBookedLeads currently tagged Meeting booked

Goals are not returned on GET /campaigns, GET /campaigns/:id, or /insights/overview.

Errors

validation_error · not_found · rate_limited

MCP

Tool: set_campaign_goal.