--- title: "Update a reward supplier" method: PUT path: "/v6/reward-suppliers/{reward_supplier_id}" tags: ["Reward Suppliers"] --- # Update a reward supplier `PUT /v6/reward-suppliers/{reward_supplier_id}` ## Request - Base URL: `https://api.extole.io` - URL: `https://api.extole.io/v6/reward-suppliers/{reward_supplier_id}` - Auth: one of: - API key in header `Authorization` - API key in query parameter `access_token` - API key in cookie `extole_token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Updates the reward supplier on the client. Only fields present in the request body are changed. Returns the updated supplier. ## Path parameters - `reward_supplier_id` string, required ## Request body - union: Body of a `PUT /v6/reward-suppliers/{reward_supplier_id}` request. - object - `cash_back_max` union: Choose between static or dynamic cash back max - number: Static cash back max - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_min` union: Choose between static or dynamic cash back min - number: Static cash back min - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_percentage` union: Choose between static or dynamic cash back percentage - number: Static cash back percentage - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `component_ids` string[] - `component_references` ComponentReferenceRequest[] - `component_id` string - `socket_names` string[] - `description` union: Choose between static or dynamic description - string, nullable: Static description - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_name` union: Choose between static or dynamic display name - string, nullable: Static display name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_type` union: Choose between static or dynamic display type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `enabled` union: Choose between static or dynamic enabled - boolean: Static enabled - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value` union: Choose between static or dynamic face value - number: Static face value - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_algorithm_type` union: Choose between static or dynamic face value algorithm type - 'CASH_BACK' | 'FIXED': Static face value algorithm type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_type` union: Choose between static or dynamic face value type - 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD': Static face value type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_day` union: Choose between static or dynamic limit per day - integer, nullable: Static limit per day - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_hour` union: Choose between static or dynamic limit per hour - integer, nullable: Static limit per hour - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `name` union: Choose between static or dynamic name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK' - `partner_reward_supplier_id` string - `reward_expires_at` union: Choose between static or dynamic reward expires at - string: Static reward expires at - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - string: Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - `reward_supplier_type` 'CUSTOM_REWARD', required - `tags` string[] - `auto_fulfillment_enabled` boolean - `missing_fulfillment_alert_delay_ms` integer - `missing_fulfillment_alert_enabled` boolean - `missing_fulfillment_auto_fail_delay_ms` integer - `missing_fulfillment_auto_fail_enabled` boolean - `reward_email_auto_send_enabled` boolean - `state_transitions` object - `type` 'ACCOUNT_CREDIT' | 'LOYALTY_POINTS' - object - `cash_back_max` union: Choose between static or dynamic cash back max - number: Static cash back max - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_min` union: Choose between static or dynamic cash back min - number: Static cash back min - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_percentage` union: Choose between static or dynamic cash back percentage - number: Static cash back percentage - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `component_ids` string[] - `component_references` ComponentReferenceRequest[] - `component_id` string - `socket_names` string[] - `description` union: Choose between static or dynamic description - string, nullable: Static description - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_name` union: Choose between static or dynamic display name - string, nullable: Static display name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_type` union: Choose between static or dynamic display type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `enabled` union: Choose between static or dynamic enabled - boolean: Static enabled - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value` union: Choose between static or dynamic face value - number: Static face value - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_algorithm_type` union: Choose between static or dynamic face value algorithm type - 'CASH_BACK' | 'FIXED': Static face value algorithm type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_type` union: Choose between static or dynamic face value type - 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD': Static face value type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_day` union: Choose between static or dynamic limit per day - integer, nullable: Static limit per day - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_hour` union: Choose between static or dynamic limit per hour - integer, nullable: Static limit per hour - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `name` union: Choose between static or dynamic name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK' - `partner_reward_supplier_id` string - `reward_expires_at` union: Choose between static or dynamic reward expires at - string: Static reward expires at - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - string: Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - `reward_supplier_type` 'MANUAL_COUPON', required - `tags` string[] - `coupon_count_warn_limit` integer - `default_coupon_expiry_date` string: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `minimum_coupon_lifetime` integer - object - `cash_back_max` union: Choose between static or dynamic cash back max - number: Static cash back max - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_min` union: Choose between static or dynamic cash back min - number: Static cash back min - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_percentage` union: Choose between static or dynamic cash back percentage - number: Static cash back percentage - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `component_ids` string[] - `component_references` ComponentReferenceRequest[] - `component_id` string - `socket_names` string[] - `description` union: Choose between static or dynamic description - string, nullable: Static description - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_name` union: Choose between static or dynamic display name - string, nullable: Static display name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_type` union: Choose between static or dynamic display type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `enabled` union: Choose between static or dynamic enabled - boolean: Static enabled - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value` union: Choose between static or dynamic face value - number: Static face value - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_algorithm_type` union: Choose between static or dynamic face value algorithm type - 'CASH_BACK' | 'FIXED': Static face value algorithm type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_type` union: Choose between static or dynamic face value type - 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD': Static face value type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_day` union: Choose between static or dynamic limit per day - integer, nullable: Static limit per day - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_hour` union: Choose between static or dynamic limit per hour - integer, nullable: Static limit per hour - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `name` union: Choose between static or dynamic name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK' - `partner_reward_supplier_id` string - `reward_expires_at` union: Choose between static or dynamic reward expires at - string: Static reward expires at - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - string: Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - `reward_supplier_type` 'PAYPAL_PAYOUTS', required - `tags` string[] - `merchant_token` string - object - `cash_back_max` union: Choose between static or dynamic cash back max - number: Static cash back max - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_min` union: Choose between static or dynamic cash back min - number: Static cash back min - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_percentage` union: Choose between static or dynamic cash back percentage - number: Static cash back percentage - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `component_ids` string[] - `component_references` ComponentReferenceRequest[] - `component_id` string - `socket_names` string[] - `description` union: Choose between static or dynamic description - string, nullable: Static description - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_name` union: Choose between static or dynamic display name - string, nullable: Static display name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_type` union: Choose between static or dynamic display type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `enabled` union: Choose between static or dynamic enabled - boolean: Static enabled - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value` union: Choose between static or dynamic face value - number: Static face value - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_algorithm_type` union: Choose between static or dynamic face value algorithm type - 'CASH_BACK' | 'FIXED': Static face value algorithm type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_type` union: Choose between static or dynamic face value type - 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD': Static face value type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_day` union: Choose between static or dynamic limit per day - integer, nullable: Static limit per day - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_hour` union: Choose between static or dynamic limit per hour - integer, nullable: Static limit per hour - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `name` union: Choose between static or dynamic name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK' - `partner_reward_supplier_id` string - `reward_expires_at` union: Choose between static or dynamic reward expires at - string: Static reward expires at - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - string: Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - `reward_supplier_type` 'SALESFORCE_COUPON', required - `tags` string[] - `balance_refill_amount` integer - object - `cash_back_max` union: Choose between static or dynamic cash back max - number: Static cash back max - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_min` union: Choose between static or dynamic cash back min - number: Static cash back min - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_percentage` union: Choose between static or dynamic cash back percentage - number: Static cash back percentage - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `component_ids` string[] - `component_references` ComponentReferenceRequest[] - `component_id` string - `socket_names` string[] - `description` union: Choose between static or dynamic description - string, nullable: Static description - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_name` union: Choose between static or dynamic display name - string, nullable: Static display name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_type` union: Choose between static or dynamic display type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `enabled` union: Choose between static or dynamic enabled - boolean: Static enabled - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value` union: Choose between static or dynamic face value - number: Static face value - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_algorithm_type` union: Choose between static or dynamic face value algorithm type - 'CASH_BACK' | 'FIXED': Static face value algorithm type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_type` union: Choose between static or dynamic face value type - 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD': Static face value type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_day` union: Choose between static or dynamic limit per day - integer, nullable: Static limit per day - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_hour` union: Choose between static or dynamic limit per hour - integer, nullable: Static limit per hour - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `name` union: Choose between static or dynamic name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK' - `partner_reward_supplier_id` string - `reward_expires_at` union: Choose between static or dynamic reward expires at - string: Static reward expires at - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - string: Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - `reward_supplier_type` 'TANGO_V2', required - `tags` string[] ## Response `200` Successful response - union - object: Stored custom reward supplier definition. Fields `name`, `display_name`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `face_value_type`, `display_type`, `enabled`, and `reward_expires_at` are unevaluated and appear in buildtime-evaluatable form. - `cash_back_max` union, required: The cash back max as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back max - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_min` union, required: The cash back min as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back min - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_percentage` union, required: The cash back percentage as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back percentage - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `created_date` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `display_name` union, required: The display name as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Literal display name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_type` union, required: The display type as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `enabled` union, required: The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean: Literal enabled - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value` union, required: The face value as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal face value - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_algorithm_type` union, required: The face value algorithm type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'CASH_BACK' | 'FIXED': Literal face value algorithm type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_type` union, required: The face value type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD': Literal face value type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `id` string, required - `limit_per_day` union, required: The limit per day as configured: a literal value, or an expression (type:string) when defined dynamically. - integer: Literal limit per day - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_hour` union, required: The limit per hour as configured: a literal value, or an expression (type:string) when defined dynamically. - integer: Literal limit per hour - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `name` union, required: The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK', required - `partner_reward_supplier_id` string, required - `reward_expires_at` union, required: The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Literal reward expires at - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - string: Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - `reward_supplier_type` 'CUSTOM_REWARD', required - `state_transitions` object, required - `tags` string[], required - `updated_date` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `auto_fulfillment_enabled` boolean, required - `missing_fulfillment_alert_delay_ms` integer, required - `missing_fulfillment_alert_enabled` boolean, required - `missing_fulfillment_auto_fail_delay_ms` integer, required - `missing_fulfillment_auto_fail_enabled` boolean, required - `reward_email_auto_send_enabled` boolean, required - `type` 'ACCOUNT_CREDIT' | 'LOYALTY_POINTS', required - object: Stored manual coupon reward supplier definition. Fields `display_type`, `face_value_type`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `name`, `display_name`, `enabled`, and `reward_expires_at` are unevaluated and appear in buildtime-evaluatable form. - `cash_back_max` union, required: The cash back max as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back max - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_min` union, required: The cash back min as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back min - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_percentage` union, required: The cash back percentage as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back percentage - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `created_date` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `display_name` union, required: The display name as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Literal display name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_type` union, required: The display type as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `enabled` union, required: The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean: Literal enabled - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value` union, required: The face value as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal face value - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_algorithm_type` union, required: The face value algorithm type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'CASH_BACK' | 'FIXED': Literal face value algorithm type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_type` union, required: The face value type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD': Literal face value type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `id` string, required - `limit_per_day` union, required: The limit per day as configured: a literal value, or an expression (type:string) when defined dynamically. - integer: Literal limit per day - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_hour` union, required: The limit per hour as configured: a literal value, or an expression (type:string) when defined dynamically. - integer: Literal limit per hour - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `name` union, required: The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK', required - `partner_reward_supplier_id` string, required - `reward_expires_at` union, required: The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Literal reward expires at - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - string: Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - `reward_supplier_type` 'MANUAL_COUPON', required - `state_transitions` object, required - `tags` string[], required - `updated_date` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `coupon_count_warn_limit` integer, required - `default_coupon_expiry_date` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `minimum_coupon_lifetime` integer, required - object: Stored pay pal payouts reward supplier definition. Fields `display_type`, `name`, `display_name`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `face_value_type`, `description`, `enabled`, and `reward_expires_at` are unevaluated and appear in buildtime-evaluatable form. - `cash_back_max` union, required: The cash back max as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back max - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_min` union, required: The cash back min as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back min - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_percentage` union, required: The cash back percentage as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back percentage - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `created_date` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `display_name` union, required: The display name as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Literal display name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_type` union, required: The display type as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `enabled` union, required: The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean: Literal enabled - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value` union, required: The face value as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal face value - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_algorithm_type` union, required: The face value algorithm type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'CASH_BACK' | 'FIXED': Literal face value algorithm type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_type` union, required: The face value type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD': Literal face value type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `id` string, required - `limit_per_day` union, required: The limit per day as configured: a literal value, or an expression (type:string) when defined dynamically. - integer: Literal limit per day - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_hour` union, required: The limit per hour as configured: a literal value, or an expression (type:string) when defined dynamically. - integer: Literal limit per hour - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `name` union, required: The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK', required - `partner_reward_supplier_id` string, required - `reward_expires_at` union, required: The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Literal reward expires at - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - string: Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - `reward_supplier_type` 'PAYPAL_PAYOUTS', required - `state_transitions` object, required - `tags` string[], required - `updated_date` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `description` union, required: The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Literal description - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `merchant_token` string, required - object: Stored salesforce coupon reward supplier definition. Fields `display_type`, `face_value_type`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `name`, `display_name`, `coupon_pool_id`, `enabled`, and `reward_expires_at` are unevaluated and appear in buildtime-evaluatable form. - `cash_back_max` union, required: The cash back max as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back max - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_min` union, required: The cash back min as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back min - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_percentage` union, required: The cash back percentage as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back percentage - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `created_date` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `display_name` union, required: The display name as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Literal display name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_type` union, required: The display type as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `enabled` union, required: The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean: Literal enabled - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value` union, required: The face value as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal face value - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_algorithm_type` union, required: The face value algorithm type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'CASH_BACK' | 'FIXED': Literal face value algorithm type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_type` union, required: The face value type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD': Literal face value type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `id` string, required - `limit_per_day` union, required: The limit per day as configured: a literal value, or an expression (type:string) when defined dynamically. - integer: Literal limit per day - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_hour` union, required: The limit per hour as configured: a literal value, or an expression (type:string) when defined dynamically. - integer: Literal limit per hour - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `name` union, required: The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK', required - `partner_reward_supplier_id` string, required - `reward_expires_at` union, required: The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Literal reward expires at - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - string: Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - `reward_supplier_type` 'SALESFORCE_COUPON', required - `state_transitions` object, required - `tags` string[], required - `updated_date` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `balance_refill_amount` integer, required - `coupon_pool_id` union, required: The coupon pool id as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `initial_offset` integer, required - `settings_id` string, required - object: Stored tango reward supplier definition. Fields `display_type`, `face_value_algorithm_type`, `face_value`, `cash_back_percentage`, `cash_back_min`, `cash_back_max`, `limit_per_day`, `limit_per_hour`, `face_value_type`, `name`, `display_name`, `description`, `enabled`, and `reward_expires_at` are unevaluated and appear in buildtime-evaluatable form. - `cash_back_max` union, required: The cash back max as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back max - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_min` union, required: The cash back min as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back min - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `cash_back_percentage` union, required: The cash back percentage as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal cash back percentage - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `created_date` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `display_name` union, required: The display name as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Literal display name - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `display_type` union, required: The display type as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `enabled` union, required: The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean: Literal enabled - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value` union, required: The face value as configured: a literal value, or an expression (type:string) when defined dynamically. - number: Literal face value - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_algorithm_type` union, required: The face value algorithm type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'CASH_BACK' | 'FIXED': Literal face value algorithm type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `face_value_type` union, required: The face value type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD': Literal face value type - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `id` string, required - `limit_per_day` union, required: The limit per day as configured: a literal value, or an expression (type:string) when defined dynamically. - integer: Literal limit per day - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `limit_per_hour` union, required: The limit per hour as configured: a literal value, or an expression (type:string) when defined dynamically. - integer: Literal limit per hour - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `name` union, required: The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `partner_reward_key_type` 'COUPON' | 'ID' | 'LINK', required - `partner_reward_supplier_id` string, required - `reward_expires_at` union, required: The reward expires at as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Literal reward expires at - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Handlebars expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - string: Javascript expression with [RewardFulfillmentEvaluationContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/RewardFulfillmentEvaluationContext.d.ts). - `reward_supplier_type` 'TANGO_V2', required - `state_transitions` object, required - `tags` string[], required - `updated_date` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `account_id` string, required - `brand_description` string, required - `brand_disclaimer` string, required - `brand_image_url` string, required - `brand_name` string, required - `description` union, required: The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string: Literal description - string: Handlebars expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - string: Javascript expression with [RewardSupplierBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/reward/supplier/built/RewardSupplierBuildtimeContext.d.ts). - `utid` string, required ## Other responses - `400`: Bad Request - `401`: Unauthorized - `402`: Payment Required - `403`: Forbidden - `415`: Unsupported Media Type - `429`: Too Many Requests - `503`: Service Unavailable --- [API](https://skmtc.dev/extole/apis/integration-api-server-to-extole.md) - [All operations](https://skmtc.dev/extole/apis/integration-api-server-to-extole/llms.txt) - [OpenAPI document](https://skmtc.dev/extole/apis/integration-api-server-to-extole/revisions/c16e62e66755?raw)