Manage Campaign Settings

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

Access

Campaign management requires Campaign Validation access. See Setting Up Purchase Validation Campaigns.

List Campaign IDs

API Reference

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 Reference

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

Path Parameters

FieldTypeDescriptionRequired
campaignIdstringThe ID of the campaign settings to retrieve. Maximum 50 characters.Yes

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 Reference

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

Path Parameters

FieldTypeDescriptionRequired
campaignIdstringThe ID of the campaign settings to update. Maximum 50 characters.Yes

Request Body

Use the same request body shape as Create Campaign Settings.

The update replaces the stored validation settings for the campaign. Include every setting section that should remain active after the update.

Successful Response

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

If the campaign ID is not found, the API returns:

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

Delete Campaign Settings

API Reference

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

Path Parameters

FieldTypeDescriptionRequired
campaignIdstringThe ID of the campaign settings to delete. Maximum 50 characters.Yes

Successful Response

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

If the campaign ID is not found, the API returns:

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

Related Pages