Enable Earning Rule

post https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable

Enable an earning rule.

Responses

`active` parameter set to `true`.

Response body

object

string

required

Assigned by the Voucherify API, identifies the earning rule object.

created_at

date-time

required

Timestamp representing the date and time when the earning rule was created. The value is shown in the ISO 8601 format.

loyalty

required

event

string

Defines the event which triggers the earning rule to add points to a loyalty card.

custom_event

object

Contains details about the custom event.

schema_id

string

required

Unique identifier of the custom event schema

segment

object

Contains the ID of a customer segment. Required for the customer.segment.entered option in the event.

string

required

Contains a unique identifier of a customer segment. Assigned by the Voucherify API.

loyalty_tier

object

Defines the tier associated with the earning rule definition.

string

Unique loyalty tier ID associated with the earning rule.

__ANY__: any loyalty tier within the campaign

pending_points

object

Defines the configuration for pending points. Pending points can be used only with the order.paid event.

period_type

string

Defines the type of the period during which the points are in the pending state. Currently, only DAY value is accepted.

DAY

period_value

integer

1 to 90

Defines for how long the points are in the pending state. The minimum value is 1, maximum is 90.

source

object

required

Contains the custom earning rule name and parent campaign.

banner

string

Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.

object_id

string

required

A unique campaign identifier assigned by the Voucherify API.

object_type

string

required

Defaults to campaign

Defines the object associated with the earning rule. Defaults to campaign.

campaign

object

string

required

Defaults to earning_rule

The type of the object represented by JSON. Default is earning_rule.

earning_rule

automation_id

string

required

For internal use by Voucherify.

start_date

string

Start date defines when the earning rule starts to be active. Activation timestamp is presented in the ISO 8601 format. The earning rule is inactive before this date. If you do not define the start date for an earning rule, it will inherit the campaign start date by default.

expiration_date

string

Expiration date defines when the earning rule expires. Expiration timestamp is presented in the ISO 8601 format. The earning rule is inactive after this date. If you do not define the expiration date for an earning rule, it will inherit the campaign expiration date by default.

validity_timeframe

object

Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.

duration

string

Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a duration of PT1H will be valid for a duration of one hour.

interval

string

Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an interval of P2D will be valid every other day.

validity_day_of_week

array of integers

Integer array corresponding to the particular days of the week in which the voucher is valid.

0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

Validity Day Of Week

validity_hours

object

Determines the hours of validity, e.g. to create a happy hours scenario.

daily

array of objects

Defines the reccuring period(s) when the resource is active. The periods should not overlap.

daily

object

start_time

string

Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.

days_of_week

array of integers

Integer array corresponding to the particular days of the week in which the resource is valid.

0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

days_of_week

expiration_time

string

Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time.

metadata

object

required

The metadata object stores all custom attributes assigned to the earning rule. A set of key/value pairs that you can attach to an earning rule object. It can be useful for storing additional information about the earning rule in a structured format.

Has additional fields

expiration_rules

object

Defines the loyalty point expiration rule. This expiration rule applies only to this earning rule and supersedes expiration_rules defined in the voucher.loyalty_card object.

period_type

string

required

Type of period. Can be set for MONTH or FIXED_DAY_OF_YEAR. MONTH requires the period_value field. FIXED_DAY_OF_YEAR requires the fixed_month and fixed_day fields.

FIXED_DAY_OF_YEAR MONTH

period_value

integer

Value of the period. Required for the period_type: MONTH.

rounding_type

string

Type of rounding of the expiration period. Optional for the period_type: MONTH.

END_OF_MONTH END_OF_QUARTER END_OF_HALF_YEAR END_OF_YEAR PARTICULAR_MONTH

rounding_value

integer

Value of rounding of the expiration period. Required for the rounding_type.

fixed_month

integer

1 to 12

Determines the month when the points expire; 1 is January, 2 is February, and so on. Required for the period_type: FIXED_DAY_OF_YEAR.

fixed_day

integer

1 to 31

Determines the day of the month when the points expire. Required for the period_type: FIXED_DAY_OF_YEAR.

updated_at

date-time | null

required

Timestamp representing the date and time when the earning rule was last updated in ISO 8601 format.

active

boolean

required

Defaults to true

A flag to toggle the earning rule on or off. You can disable an earning rule even though it's within the active period defined by the start_date and expiration_date of the campaign or the earning rule's own start_date and expiration_date.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.voucherify.io/v1/loyalties/campaignId/earning-rules/earningRuleId/enable \
3
     --header 'X-Voucherify-Channel: Voucherify Documentation' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns an earning rule object with the active parameter set to true.

404Returns an error if the resource cannot be found.

`active` parameter set to `true`.