Managing Campaigns

Use these endpoints to list, retrieve, update, and delete campaign settings after they have been created with Create Campaign Settings.

Availability

📘

Availability: Receipt validation is included on the Advanced plan and above. Enable Campaign Validation in your account Feature Settings when it is available on your plan. See Plans & Feature Access and Setting Up Validation Campaigns.

List Campaign IDs

API console: List Campaign IDs

Endpoint: GET https://api.taggun.io/api/validation/v1/campaign/settings/list

Request

No path parameters or request body are required.

Response

Returns an array of campaign IDs for your account.

["coffee-june-2026", "summer-promo-2026"]

Get Campaign Settings

API console: Get Campaign Setting Details

Endpoint: GET https://api.taggun.io/api/validation/v1/campaign/settings/{campaignId}

Path parameters

Response

Returns the campaign validation settings object. Empty setting sections may be omitted from the response.

{
  "date": {
    "start": "2026-06-01T00:00:00.000Z",
    "end": "2026-06-30T23:59:59.999Z"
  },
  "merchantNames": {
    "allowList": ["Fresh Market"]
  },
  "productCodes": {
    "description": "Find product codes printed beside eligible coffee products",
    "list": ["COF-250", "COF-500"]
  },
  "fraudDetection": {
    "allowSimilarityCheck": true
  }
}

If the campaign ID is not found, the API returns a 404 response with the message Cannot find settings for the campaign ID - {campaignId}.

Update Campaign Settings

API console: Update Campaign Settings

Endpoint: PUT https://api.taggun.io/api/validation/v1/campaign/settings/update/{campaignId}

Path parameters

Request body

Use the same request body shape as Campaign Settings Reference.

🚧

The update replaces the stored validation settings for the campaign. Include every setting section that should remain active after the update — any section you omit is removed.

Response

{
  "result": "Successfully updated campaign settings for campaign - coffee-june-2026",
  "statusCode": 200
}

If the campaign ID is not found:

{
  "result": "Campaign ID not found - coffee-june-2026",
  "statusCode": 404
}

Delete Campaign Settings

API console: Delete Campaign Settings

Endpoint: DELETE https://api.taggun.io/api/validation/v1/campaign/settings/delete/{campaignId}

Path parameters

Response

{
  "result": "Successfully remove campaign settings for campaign - coffee-june-2026",
  "statusCode": 200
}

If the campaign ID is not found:

{
  "result": "Campaign ID not found - coffee-june-2026",
  "statusCode": 404
}

🚧

Submissions against a deleted campaign cannot evaluate the removed rules. The exact receipt-validation failure status and body are not yet a documented contract. Delete settings deliberately when a campaign ends — or leave them in place if late submissions should still validate against the date window.

Need something not covered here? Contact [email protected] — see Contacting Support.