v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Earning Rules

Update earning rule

<Badge color="yellow">BETA endpoint</Badge>

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

</Warning>

Updates an earning rule. All properties are optional; status cannot be changed through this endpoint (use the activate/deactivate/draft endpoints). For rules that are not in DRAFT status, only the following properties may effectively change: name, earnings, error, validity_hours, start_date, end_date, trigger_limits, metadata. Earnings items may carry an id (lernei_...) to update an existing earning item; items without an id are created.

put/v2/loyalties/earning-rules/{earningRuleId}

Path parameters

idstring required

Earning rule ID.

Request body

namestring

Earning rule name.

start_datestring date-time

Date-time from which the rule is active. Nullable.

end_datestring date-time

Date-time until which the rule is active. Nullable.

metadataEarningRuleMetadata

Arbitrary key-value metadata; any JSON object is accepted.

Response

Updated earning rule

idstring

Earning rule ID (lern_...).

namestring

Earning rule name.

status'DRAFT' | 'ACTIVE' | 'INACTIVE'

Current status. DELETED also exists internally but deleted rules are excluded from API reads.

start_datestring date-time

Date-time from which the rule is active. Nullable.

end_datestring date-time

Date-time until which the rule is active. Nullable.

metadataEarningRuleMetadata

Arbitrary key-value metadata; any JSON object is accepted.

created_atstring date-time

Creation timestamp (ISO 8601).

updated_atstring date-time

Last update timestamp (ISO 8601). Null when never updated.

objectstring

Object type marker. Always earning_rule.