Definitions for Create Campaign Settings
This API is used to create a campaign with specific validation rules for receipt submissions.
Endpoint: POST https://api.taggun.io/api/validation/v1/campaign/settings/create/{campaignId}
Request Definitions
Field | Type | Description | Required |
---|---|---|---|
date | object | Defines the start and end date for the campaign. | Yes |
date.start | string | Start date for the campaign in ISO 8601 format. | Yes |
date.end | string | End date for the campaign in ISO 8601 format. | Yes |
merchantNames | object | List of participating merchants and validation rules. | No |
merchantNames.skip | boolean | Whether to skip merchant name validation. | No |
merchantNames.list | string[] | List of merchant names to validate against. | No |
productLineItems | object | Defines eligible product names, quantities, and price range. | No |
productLineItems.skip | boolean | Whether to skip product line validation. | No |
productLineItems.names | string[] | List of product names to validate against. | No |
productLineItems.totalPrice.min | number | Minimum allowable price for product line items. | No |
productLineItems.totalPrice.max | number | Maximum allowable price for product line items. | No |
productLineItems.quantity.min | number | Minimum quantity of items for validation. | No |
productLineItems.quantity.max | number | Maximum quantity of items for validation. | No |
productCodes | object | Product codes relevant to the campaign. | No |
productCodes.skip | boolean | Whether to skip product code validation. | No |
balanceOwing | object | Defines validation rules for the total balance on receipts. | No |
balanceOwing.skip | boolean | Whether to skip balance owing validation. | No |
balanceOwing.max | number | Maximum balance owing allowed for the receipt. | No |
fraudDetection | object | Settings for fraud detection and similarity checks. | No |
fraudDetection.allowSimilarityCheck | boolean | Whether to allow fraud detection based on receipt similarity. | No |
smartValidate | object | Additional custom validation questions. | No |
smartValidate.skip | boolean | Whether to skip smart validation questions. | No |
smartValidate.validationQuestions | object[] | List of validation questions and expected answers. | No |
Response Definitions
Field | Type | Description |
---|---|---|
result | string | A message indicating the outcome of the operation. |
statusCode | number | The HTTP status code of the response. |
Updated 22 days ago