latestOpenAPI 3.0.12026-08-20112309904.6 KB

466169815b78

Collections - Targets

Remove target from collection

Remove a single target from a collection.

The target is identified by its prewaveTargetId (target's infotag_id) in the URL path. If the target is not currently in the collection, the operation will complete successfully without error (idempotent operation).

Getting Collection ID:

  • To find available collections and their IDs, use the Collections Management API:
    • GET /public/v1/collections - List all collections accessible to you (returns collections with id field)
    • GET /public/v1/collections/{collectionId} - Get a specific collection by ID
  • The id field in collection responses is the collectionId used in this endpoint's path parameter

Getting Target ID (prewaveTargetId):

  • To get the current target ID, use the Supplier Sites API or the collection targets endpoint:
    • GET /public/v1/collections/{collectionId}/targets - List all targets in the collection with their current prewaveTargetId values
    • GET /public/v2/suppliers/sites - List all suppliers with their current prewaveTargetId values
    • GET /public/v2/suppliers/sites/find-by-identifier?prewaveId={prewaveTargetId} - Get a specific supplier by prewaveTargetId
  • The id field in target/supplier responses is the prewaveTargetId used in this endpoint's path parameter

Important: Target ID Stability

⚠️ The target id (prewaveTargetId) may change due to target merges or data consolidation. When this happens:

  • The target's edge numbers, edge data, and collection memberships are automatically moved to a new target
  • Using an outdated target ID will result in a 404 Not Found error

💡 Best Practice for Integrations:

  • Always use current target IDs when removing targets from collections
  • Use GET /public/v1/collections/{collectionId}/targets to get the current target IDs in the collection before removing them
  • Alternatively, use GET /public/v2/suppliers/sites to find the current prewaveTargetId by matching your supplier identifiers
  • If you receive a 404 Not Found error, use GET /public/v2/suppliers/sites to find the current prewaveTargetId by matching your supplier identifiers

Audit Trail:

  • All changes are audited for compliance and tracking purposes
  • Every action is recorded in the audit log with:
    • The user who performed the operation
    • Timestamp of the operation
    • Details about which target was removed from the collection
    • Reference to the public API endpoint used

Required Permissions: manage_collection and update on the collection.

delete/public/v1/collections/{collectionId}/targets/{targetId}

Path parameters

collectionIdinteger required

Unique identifier of the collection

targetIdinteger required

The prewaveTargetId (target's infotag_id) of the target to remove from the collection. This is the same identifier returned in the id field when retrieving targets via GET /public/v1/collections/{collectionId}/targets or GET /public/v2/suppliers/sites.

Response

Target removed from collection successfully (or was not in collection). All changes have been audited.