Skip to content

API referenceCollections

Delete a collection

DELETE/v1/collections/{id}

Deletes the Collection. Its Trackers keep running unless delete_trackers=true, which deletes the members that sit in no other Collection. The response always lists the former members still active, which are still charged every cycle.

Price

Free.

Parameters

NameInTypeRequiredDefaultDescription
idpathstringRequired—Collection id.
delete_trackersquerybooleanOptionalfalseAlso delete member Trackers that are in no other Collection. Default false.

Responses

200 OK

{ collection, deleted_trackers, trackers_still_active }.

object

  • collectionobjectrequiredThe Collection as it was.
    • idstringrequired
    • namestringrequiredUnique per Customer, regardless of case.
    • kindstringrequiredone of creator, hashtag, sound, advertiser, videoWhat every member is. Fixed at creation. video is deprecated: existing Video Collections keep working, new ones are refused with 400 kind_deprecated.
    • member_countintegerrequiredLive (active or paused) member Trackers.
    • created_atstringrequired
    • updated_atstringrequired
  • deleted_trackersarray of objectrequiredDeleted with it; only with delete_trackers=true.
    • idstringrequired
    • kindstringrequiredone of creator, hashtag, sound, advertiser, videovideo is deprecated (ADR 0024): existing Video Trackers keep working, new ones are refused with 400 kind_deprecated.
    • platformstringrequiredmeta for an advertiser Tracker.
    • targetstringrequired
    • intelligencebooleanrequiredWhether each new video (or Ad) the cycle finds is analysed.
    • statestringrequiredone of active, paused, deleted
    • last_cycle_atstringrequirednullable
    • last_run_idstringrequirednullable
    • created_atstringrequired
    • updated_atstringrequired
  • trackers_still_activearray of objectrequiredFormer members still active, and so still charged each cycle.
    • idstringrequired
    • kindstringrequiredone of creator, hashtag, sound, advertiser, videovideo is deprecated (ADR 0024): existing Video Trackers keep working, new ones are refused with 400 kind_deprecated.
    • platformstringrequiredmeta for an advertiser Tracker.
    • targetstringrequired
    • intelligencebooleanrequiredWhether each new video (or Ad) the cycle finds is analysed.
    • statestringrequiredone of active, paused, deleted
    • last_cycle_atstringrequirednullable
    • last_run_idstringrequirednullable
    • created_atstringrequired
    • updated_atstringrequired

200 · `{ collection, deleted_trackers, trackers_still_active }`.

{
  "collection": {
    "id": "col_7d20e1b5c4",
    "name": "Competitors",
    "kind": "creator",
    "member_count": 4,
    "created_at": "2026-09-02T09:14:40.221Z",
    "updated_at": "2026-09-02T09:14:40.221Z"
  },
  "deleted_trackers": [],
  "trackers_still_active": [
    {
      "id": "trk_4b1e90c7aa",
      "kind": "creator",
      "platform": "tiktok",
      "target": "someone",
      "intelligence": true,
      "state": "active",
      "last_cycle_at": "2026-09-08T04:00:11.402Z",
      "last_run_id": "run_c07a41bb92",
      "created_at": "2026-09-01T11:20:03.118Z",
      "updated_at": "2026-09-08T04:00:11.402Z"
    }
  ]
}

400 Bad Request

invalid_request — delete_trackers other than true or false.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose.

  • typestringrequired
  • titlestringrequired
  • statusintegerrequired
  • codestringrequiredone of missing_authorization, invalid_key, key_revoked, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, rate_limit_exceeded, concurrency_limit_exceeded, tracker_limit_exceeded, webhook_limit_exceeded, webhook_rotation_in_progress, collection_limit_exceeded, collection_name_taken, collection_kind_mismatch, media_unavailable, vendor_error, source_unavailable, service_unavailable, internal_errorStable machine-readable code.
  • detailstring

400 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "code": "invalid_request",
  "detail": "delete_trackers: Invalid enum value."
}

401 Unauthorized

missing_authorization, invalid_key, key_revoked or invalid_token.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose.

  • typestringrequired
  • titlestringrequired
  • statusintegerrequired
  • codestringrequiredone of missing_authorization, invalid_key, key_revoked, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, rate_limit_exceeded, concurrency_limit_exceeded, tracker_limit_exceeded, webhook_limit_exceeded, webhook_rotation_in_progress, collection_limit_exceeded, collection_name_taken, collection_kind_mismatch, media_unavailable, vendor_error, source_unavailable, service_unavailable, internal_errorStable machine-readable code.
  • detailstring

401 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/invalid_key",
  "title": "Invalid key",
  "status": 401,
  "code": "invalid_key",
  "detail": "That API key does not exist. Keys look like `sk_live_...` and are created in the console."
}

404 Not Found

not_found.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose.

  • typestringrequired
  • titlestringrequired
  • statusintegerrequired
  • codestringrequiredone of missing_authorization, invalid_key, key_revoked, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, rate_limit_exceeded, concurrency_limit_exceeded, tracker_limit_exceeded, webhook_limit_exceeded, webhook_rotation_in_progress, collection_limit_exceeded, collection_name_taken, collection_kind_mismatch, media_unavailable, vendor_error, source_unavailable, service_unavailable, internal_errorStable machine-readable code.
  • detailstring

404 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "No Collection with that id for this Customer."
}

Request samples

curl -X DELETE "https://www.shortsintel.com/v1/collections/col_7d20e1b5c4?delete_trackers=false" \
  -H "Authorization: Bearer sk_live_YOUR_KEY"