Competitor Tracker & Co. Docs
Dispatches

Add a recipient to a notification. Members are added immediately; external recipients are emailed a confirmation link and stay pending until they confirm. Admin-only.

Add a recipient to a notification. Members are added immediately; external recipients are emailed a confirmation link and stay pending until they confirm.

Required role: admin or higher (organization-level).

Required scope: dispatches:write (for both OAuth2 tokens and API keys).

POST
/v1/dispatches/{id}/recipients

Authorization

X-API-Key<token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://api.competitortracker.io/v1/dispatches/string/recipients" \  -H "Content-Type: application/json" \  -d '{    "kind": "external"  }'
{
  "id": "string",
  "kind": "member",
  "userId": "string",
  "name": "string",
  "email": "string",
  "confirmationStatus": "confirmed",
  "isOwnerPin": true
}
{
  "code": "string",
  "message": "string",
  "resolution": "string"
}
{
  "code": "string",
  "message": "string",
  "resolution": "string"
}

Delete a non-default notification belonging to the current organization. DELETE

Delete a non-default notification belonging to the current organization — Competitor Tracker & Co. API reference for DELETE /v1/dispatches/{id}: request.

Remove a recipient from a notification. The pinned owner cannot be removed. Admin-only. DELETE

Remove a recipient from a notification. The pinned owner cannot be removed. Admin-only — Competitor Tracker & Co. API reference for DELETE /v1/dispatches/{id}/.