--- title: "Examine Campaign Qualification" method: POST path: "/v1/campaigns/qualification" tags: ["Campaigns"] deprecated: true --- # Examine Campaign Qualification `POST /v1/campaigns/qualification` > **Deprecated.** > ❗️ Deprecated > > This endpoint represents the deprecated version of the API responsible for qualification, and we do not recommend using it. The new [Qualifications API](/api-reference/qualifications/check-eligibility) introduces additional features and improvements while maintaining backward compatibility. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint. The method can be used for sending a request to display all campaigns qualified to the given customer and context (e.g., order). The maximum number of **returned campaigns is 50**. ## What campaign types are included in the response? - `DISCOUNT_COUPONS` - `GIFT_VOUCHERS` - `REFERRAL_PROGRAM` ## What's excluded? A checking logic will be run only among campaigns and will ignore _generic (standalone) vouchers_. For generic (standalone) vouchers, you should run a [dedicated endpoint](/api-reference/vouchers/examine-voucher-qualification) for searching and identifing vouchers. ## Subsequent Steps As a recommended subsequent step after selecting a qualified campaign is to publish a voucher code from that campaign. The [API method for publishing](/api-reference/publications/create-publication) will return a unique code which will belong to a given customer. ## Sample use case As a sample use case, you can imagine a requirement of displaying coupons (grouped in campaigns) that a customer is eligible to use. The customer should get assigned to the particular voucher from the campaign and then may redeem that particular code when he/she places an order. [Read](/guides/checking-eligibility) about Qualification API limits before you start. ## Query parameters - `audienceRulesOnly` boolean - `limit` integer - `order` 'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'type' | '-type' | 'code' | '-code' | 'category' | '-category' | 'campaign' | '-campaign' ## Request body - 2ReqExamineQualification — Request body schema for **POST** `v1/campaigns/qualification`. - `customer` union — Customer's information. - 6ReqValidateVoucherCustomerId — You can pass the unique customer ID that was assigned by Voucherify. - `id` string — The ID of an existing customer that will be linked to redemption in this request. - 6ReqValidateVoucherCustomerSourceId — You can send the source ID that you used to create the customer in Voucherify. - `source_id` string — A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. - 9ReqCreateCustomer — This is an object containing information about the customer. - `source_id` string — The merchant's customer ID if it is different from the Voucherify customer ID. It is really useful in case of an integration between multiple systems. It can be a customer ID from a CRM system, database or 3rd-party service. Please note that if you would like your data to sync based on the `source_id` of the customer, you need to define the `source_id` upfront. You will not be able to change or update the `source_id` later on. - `name` string — Customer's first and last name. - `description` string — An arbitrary string that you can attach to a customer object. - `email` string — Customer's email address. - `phone` string — Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel. - `address` object — Customer's address. - `city` string — City - `state` string — State - `line_1` string — First line of address. - `line_2` string — Second line of address. - `country` string — Country. - `postal_code` string — Postal code. - `birthdate` string, date — Customer's birthdate; format `YYYY-MM-DD`. - `birthday` string, date — `Deprecated`. ~~Customer's birthdate; format `YYYY-MM-DD`~~. - `metadata` object — A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. - `order` union — Order information. This object enables you to pass purchase transaction data. Read what properties you can use in the [Order object](/api-reference/orders/order-calculated-object). - 6ReqValidateVoucherOrderId — You can pass the unique order ID that was assigned by Voucherify. - `id` string — Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. - 6ReqValidateVoucherOrderSourceId — You can send the source ID that you used to create the order in Voucherify. - `source_id` string — Unique source ID of an existing order that will be linked to the redemption of this request. - OrdersCreateRequestBody — Order information. - `id` string — Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. - `source_id` string, nullable — Unique source ID of an existing order that will be linked to the redemption of this request. For validation and redemption, if `source_id` is used with an existing order, the original order data will be used, like `items`, `amount`, and so on, not the one sent in the new request. - `status` 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED' — The order status. - `amount` integer — A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. - `initial_amount` integer — A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. - `discount_amount` integer — Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). - `items` OrderItem[] — Array of items applied to the order. It can include up to 500 items. - `sku_id` string — Unique identifier of the SKU. It is assigned by Voucherify. - `product_id` string — Unique identifier of the product. It is assigned by Voucherify. - `related_object` 'product' | 'sku' — Used along with the source_id property, can be set to either sku or product. - `source_id` string — The merchant's product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service. - `quantity` integer — The quantity of the particular item in the cart. - `discount_quantity` integer — Number of dicounted items. - `initial_quantity` integer — A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items' quantity. - `amount` integer — The total amount of the order item (price * quantity). - `discount_amount` integer — Sum of all order-item-level discounts applied to the order. - `initial_amount` integer — A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. - `price` integer — Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. - `product` object — An object containing details of the related product. - `id` string — A unique identifier that represents the product and is assigned by Voucherify. - `source_id` string — The merchant's product ID (if it is different than Voucherify's product ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. - `override` boolean — The override set to `true` is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. Override works only for endpoints that create an order in the database. - `name` string — Product name. - `metadata` object — A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections. - `price` number — Product price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00). - `sku` object — An object containing details of the related SKU. - `id` string — A unique identifier that represents the SKU and is assigned by Voucherify. - `source_id` string — The merchant's SKU ID (if it is different than Voucherify's SKU ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. - `override` boolean — The override set to `true` is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. - `sku` string — The SKU name. - `price` number — SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00). - `metadata` object — A set of custom key/value pairs that you can attach to an order item. It can be useful for storing additional information about the order item in a structured format. It can be used to create product collections. - `metadata` object — A set of custom key/value pairs that you can attach to an order item. It can be useful for storing additional information about the order item in a structured format. It can be used to define business validation rules. - `metadata` object — A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. - `created_at` string, date-time — Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. - `referrer_id` string, nullable — Unique referrer ID. - `customer` Customer - `id` string — The ID of an existing customer. - `source_id` string — A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. - `name` string — Customer's first and last name. - `description` string — An arbitrary string that you can attach to a customer object. - `email` string — Customer's email address. - `phone` string — Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel. - `birthday` string, date — `Deprecated`. ~~Customer's birthdate; format YYYY-MM-DD~~. - `birthdate` string, date — Customer's birthdate; format YYYY-MM-DD. - `address` object, nullable — Customer's address. - `city` string — City - `state` string — State - `line_1` string — First line of address. - `line_2` string — Second line of address. - `country` string — Country. - `postal_code` string — Postal code. - `metadata` object — A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. - `referrer` Referrer - `id` string — The ID of an existing customer. - `source_id` string — A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. - `name` string — Customer's first and last name. - `description` string — An arbitrary string that you can attach to a customer object. - `email` string — Customer's email address. - `phone` string — Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel. - `birthday` string, date — `Deprecated`. ~~Customer's birthdate; format YYYY-MM-DD~~. - `birthdate` string, date — Customer's birthdate; format YYYY-MM-DD. - `address` object, nullable — Customer's address. - `city` string — City - `state` string — State - `line_1` string — First line of address. - `line_2` string — Second line of address. - `country` string — Country. - `postal_code` string — Postal code. - `metadata` object — A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. ## Response `200` This operation returns the list of valid and active campaigns based on the qualification of a given context (e.g., customer profile, redemptions metadata, order). [Read](/guides/checking-eligibility) about Qualification API limits before you start. - 2ResExamineQualification — Response body schema for **POST** `v1/campaigns/qualification`. - `object` string — The type of the object represented by JSON. This object stores information about campaigns in a dictionary. - `data_ref` string — Identifies the name of the attribute that contains the array of campaign objects. - `data` 2ObjCampaignObjectCampaignsQualification[] — Contains array of campaign objects. - `id` string — Unique campaign ID, assigned by Voucherify. - `name` string — Campaign name. - `description` string — An optional field to keep any extra textual information about the campaign such as a campaign description and details. - `campaign_type` 'GIFT_VOUCHERS' | 'DISCOUNT_COUPONS' | 'REFERRAL_PROGRAM' — Type of campaign. - `type` 'AUTO_UPDATE' | 'STATIC' — Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published - `voucher` union - 2ObjCampaignObjectVoucherObjectDISCOUNT — Schema model for a discount voucher. - `type` string — Type of voucher. - `discount` union — Defines the voucher discount type and details. - 1ObjVoucherObjectDiscountAmount — Amount discount type. - `type` string — Applies an amount discount. - `amount_off` integer — Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. In case of the amount being calculated by the formula, i.e. the `amount_off_formula` parameter is present in the amount definition, this value becomes the **fallback value**. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the amount off. - `amount_off_formula` string — Formula used to dynamically calculate the discount. - `aggregated_amount_limit` integer — Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value) - `effect` 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS' | 'APPLY_TO_ITEMS_PROPORTIONALLY' | 'APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY' | 'APPLY_TO_ITEMS_BY_QUANTITY' — Defines how the discount is applied to the customer's order. The discount effects are defined as follows: - `APPLY_TO_ORDER` (discount applies to the total order amount) - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_PROPORTIONALLY` (split discount proportionally to amount) - `APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY` (split discount proportionally to quantity) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value) - 1ObjVoucherObjectDiscountPercentage — Percentage discount type. - `type` string — Applies a percentage discount. - `amount_limit` string — Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. - `aggregated_amount_limit` integer — Maximum discount amount per order. This value is definable for the `APPLY_TO_ITEMS` discount effect. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. - `percent_off` integer — Percent taken off the subtotal amount. In case of the percent being calculated by the formula, i.e. the `percent_off_formula` parameter is present in the percent definition, this value becomes the **fallback value**. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the percent off. - `percent_off_formula` string — Formula used to dynamically calculate the discount. - `effect` 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS' — Defines how the discount is applied to the customer's order. - 1ObjVoucherObjectDiscountFixed — Fixed discount type. - `type` string — Sets a fixed total on cart or item(s) and then calculates the discount to apply. - `fixed_amount` integer — Sets a fixed value for an order total or the item price. The value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. If the fixed amount is calculated by the formula, i.e. the `fixed_amount_formula` parameter is present in the fixed amount definition, this value becomes the **fallback value**. As a result, if the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value. - `fixed_amount_formula` string — Formula used to dynamically calculate the discounted price of an item or a new order total. - `effect` 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS' — | **Effect** | **Definition** | |:---|:---| | **APPLY_TO_ORDER** | Sets the order total amount to the value of the fixed amount. The discount value is calculated dynamically during the redemption as it's a difference between the total amount of the customer's order and the fixed amount. For example, if the fixed amount is set to equal $10 and the order amount equals $25, then the calculated discount will be $15. | | **APPLY_TO_ITEMS** | Sets a new price on items. The total discount amount is dynamically calculated during the redemption and it's a difference between the initial item price and the fixed amount. During the redemption, prices for items will change only if the new price is lower than the original price. If the new product price you set is different from the product price in a collection, then the new product price will be passed during the redemption. If a prodct is in more than one collection, the price is always changed to the lowest price. The new price for products with several SKUs will force the price change for SKUs if their original price is higher than the new price. | - 1ObjVoucherObjectDiscountUnitOne — Single item type. - `type` string — Applies a full value discount to item(s). - `unit_off` number, float — Number of units to be granted a full value discount. In case of the unit being calculated by the formula, i.e. the `unit_off_formula` parameter is present in the unit definition, this value becomes the **fallback value**. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the unit value. - `unit_off_formula` string — Formula used to dynamically calculate the number of units. - `unit_type` string — The product deemed as free, chosen from the product inventory (e.g. time, items). - `effect` 'ADD_NEW_ITEMS' | 'ADD_MISSING_ITEMS' — Defines how the unit is added to the customer's order. - 1ObjVoucherObjectDiscountUnitMultiple — Multiple item types. - `type` string — Applies a full value discount to item(s). - `effect` string — Defines the effect for adding multiple item types. - `units` object[] — Array of objects defining items to be offered for free. Each item type can have a different discount effect assigned. - … - 1ObjVoucherObjectDiscountShipping — Shipping discount type. - `type` string — Applies a full value discount to item(s). - `unit_off` number, float — Subtracts 1 shipping item from the subtotal. - `unit_type` string — The shipping product deemed as free. - `effect` string — Defines how the unit is added to the customer's order. - `redemption` object — Defines the redemption limits on vouchers. - `quantity` integer — How many times a voucher can be redeemed. A `null` value means unlimited. - `code_config` object — Defines code's pattern (prefix, suffix, length, charset, etc). - `length` string — Number of characters in a generated code (excluding prefix and postfix). - `charset` string — Characters that can appear in the code. Examples: - Alphanumeric: `0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ` - Alphabetic: `abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ` - Alphabetic Lowercase: `abcdefghijklmnopqrstuvwxyz` - Alphabetic Uppercase: `ABCDEFGHIJKLMNOPQRSTUVWXYZ` - Numbers: `0123456789` - Custom: a custom character set - `prefix` string — A text appended before the code. - `postfix` string — A text appended after the code. - `pattern` string — A pattern for codes where hashes (#) will be replaced with random characters. Overrides `length`. - `is_referral_code` boolean — Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. - 2ObjCampaignObjectVoucherObjectGIFTCARD — Schema model for a gift card. - `type` string — Type of voucher. - `gift` object — Defines the gift card details. - `amount` integer — Initial gift card income to be applied to the gift card at voucher generation. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. - `effect` 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS' — Defines how the credits are applied to the customer's order. - `redemption` object — Defines the redemption limits on vouchers. - `quantity` integer — How many times a voucher can be redeemed. A `null` value means unlimited. - `code_config` object — Defines code's pattern (prefix, suffix, length, charset, etc). - `length` string — Number of characters in a generated code (excluding prefix and postfix). - `charset` string — Characters that can appear in the code. Examples: - Alphanumeric: `0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ` - Alphabetic: `abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ` - Alphabetic Lowercase: `abcdefghijklmnopqrstuvwxyz` - Alphabetic Uppercase: `ABCDEFGHIJKLMNOPQRSTUVWXYZ` - Numbers: `0123456789` - Custom: a custom character set - `prefix` string — A text appended before the code. - `postfix` string — A text appended after the code. - `pattern` string — A pattern for codes where hashes (#) will be replaced with random characters. Overrides `length`. - `is_referral_code` boolean — Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. - 2ObjCampaignObjectVoucherObjectLOYALTYCARD — Schema model for a loyalty card. - `type` string — Type of voucher. - `loyalty_card` object — Defines the loyalty card details. - `points` integer — Initial loyalty card income in points to be applied to the loyalty card at voucher generation. - `expiration_rules` object — Defines point expiration rules. - `period_type` 'MONTH' — The expiration period. - `period_value` integer — How many periods should pass before the expiration occurs. - `rounding_type` 'END_OF_MONTH' | 'END_OF_QUARTER' | 'END_OF_HALF_YEAR' | 'END_OF_YEAR' | 'PARTICULAR_MONTH' — Round up expiration till the end of the given period type. - `redemption` object — Defines the redemption limits on vouchers. - `quantity` integer — How many times a voucher can be redeemed. A `null` value means unlimited. - `code_config` object — Defines code's pattern (prefix, suffix, length, charset, etc). - `length` string — Number of characters in a generated code (excluding prefix and postfix). - `charset` string — Characters that can appear in the code. Examples: - Alphanumeric: `0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ` - Alphabetic: `abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ` - Alphabetic Lowercase: `abcdefghijklmnopqrstuvwxyz` - Alphabetic Uppercase: `ABCDEFGHIJKLMNOPQRSTUVWXYZ` - Numbers: `0123456789` - Custom: a custom character set - `prefix` string — A text appended before the code. - `postfix` string — A text appended after the code. - `pattern` string — A pattern for codes where hashes (#) will be replaced with random characters. Overrides `length`. - `is_referral_code` boolean — Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. - `auto_join` boolean — Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. - `join_once` boolean — If this value is set to `true`, customers will be able to join the campaign only once. - `use_voucher_metadata_schema` boolean — Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. - `validity_timeframe` ValidityTimeframe — Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.`start_date` **required** when including the `validity_timeframe`. - `duration` string — Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a `duration` of `PT1H` will be valid for a duration of one hour. - `interval` string — Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an `interval` of `P2D` will be valid every other day. - `validity_day_of_week` integer[] — Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday - `validity_hours` ValidityHours — Determines the hours of validity, e.g. to create a happy hours scenario. - `daily` object[] — Defines the recurring period(s) when the resource is active. The periods should not overlap. - `start_time` string, time — Defines the starting hour of validity in the HH:mm format. The resource is *inactive before* this time. - `days_of_week` integer[] — Integer array corresponding to the particular days of the week in which the resource is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday - `expiration_time` string, time — Defines the ending hour of validity in the HH:mm format. The resource is *inactive after* this time. - `activity_duration_after_publishing` string — Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. - `vouchers_count` integer — Total number of unique vouchers in campaign. - `start_date` string, date-time — Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date. - `expiration_date` string, date-time — Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is *inactive after* this date. - `active` boolean — A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign - `metadata` object — The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. - `created_at` string, date-time — Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. - `updated_at` string, date-time — Timestamp representing the date and time when the voucher was updated. The value is shown in the ISO 8601 format. - `category` string — Unique category name. - `creation_status` 'DONE' | 'IN_PROGRESS' | 'FAILED' | 'DRAFT' | 'MODIFYING' — Indicates the status of the campaign creation. - `vouchers_generation_status` 'DONE' | 'IN_PROGRESS' | 'FAILED' | 'DRAFT' — Indicates the status of the campaign's vouchers. - `protected` boolean — Indicates whether the resource can be deleted. - `validation_rules_assignments` object — Stores information about validation rules assigned to the campaign. - `object` string — The type of the object represented is by default `list`. - `data_ref` string — Identifies the name of the attribute that contains the array of validation rule assignments. - `data` object[] — Array of validation rule assignment objects. Each validation rule assignment object contains details about the rule. - `id` string — Assigned by the Voucherify API, identifies the validation rule assignment. - `rule_id` string — Assigned by the Voucherify API, identifies the validation rule. - `related_object_id` string — ID of the object from which the rule originates. - `related_object_type` string — Which object does the rule originate from: the `voucher` itself or inherited from its parent `campaign`. - `created_at` string, date-time — Timestamp representing the date and time when the validation rule was created. The value is shown in the ISO 8601 format. - `object` string — The type of resource represented by the object. Default is `validation_rules_assignment`. - `rule` object — Describes the details of the rule. - `total` integer — Total number of validation rules assigned to the campaign. - `category_id` string — Unique category ID that this campaign belongs to. - `categories` Category — This is an object representing a category. - `id` string, required — Unique category ID assigned by Voucherify. - `name` string, required — Category name. - `hierarchy` integer, required — Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value. - `object` 'category', required — The type of the object represented by the JSON. This object stores information about the category. - `created_at` string, date-time, required — Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format. - `updated_at` string, date-time — Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format. - `object` string — The type of the object represented by JSON. This object stores information about the campaign. - `referral_program` object — Defines the referee reward and the way a referral is triggered. Context: `REFERRAL_PROGRAM`. - `conversion_event_type` 'redemption' | 'custom_event' — How a referral is triggered. - `custom_event` object — Contains details about the custom event. - `id` string — Unique custom event ID. - `name` string — Custom event name. - `referee_reward` object — Defines the referee reward. - `related_object_parent` object — Details of the resource from which the reward originates. - `id` string — Unique ID of the reward source. - `name` string — Name of the reward source. - `object` string — Type of resource represented by the source of the reward. - `type` 'LOYALTY_CARD' | 'GIFT_VOUCHER' — Type of reward. - `amount` string — The number of `points` to add to a loyalty card or `credits` to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. - `total` integer — Total valid and active campaigns matching the qualification criteria in given context. - `id` string — Unique qualification ID. - `created_at` string, date-time — Timestamp representing the date and time when the qualification was created. The value is shown in the ISO 8601 format. - `tracking_id` string — Hashed customer source ID. --- [API](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions.md) · [All operations](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voucherifyio/voucherify-api-async-actions/versions/4982266e0494/schema)