Earning Rules

Update earning rule

Changed on
<Info>

<Badge color="gray">Documentation in progress</Badge>

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

</Info>

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, earning_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}

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/earning-rules/{earningRuleId}
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or HTTP bearer

Request body

start_datestring date-time nullable

Date-time from which the rule is active. Can be null. When both start_date and end_date are set, start_date must be earlier than end_date.

end_datestring date-time nullable

Date-time until which the rule is active. Can be null.

metadataLoyaltyV2ActivityMetadata

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

namestring

Earning rule name.

Response

Updated earning rule

idstring required

Earning rule ID (lern_...).

namestring required

Earning rule name.

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

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

start_datestring date-time nullable required

Date-time from which the rule is active. Can be null.

end_datestring date-time nullable required

Date-time until which the rule is active. Can be null.

metadataLoyaltyV2ActivityMetadata required

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

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time nullable required

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

object'earning_rule' required

Object type marker. Always earning_rule.

Changes

  • v2d29b33490051Revision changes
    • breaking

      added subschema #2 to the /// request property allOf list

    • breaking

      the /// request property type changed from object to no type

    • breaking

      the /////////// response's property type changed from object to no type for status

    • breaking

      the /////////// response's property type changed from object to no type for status

    • breaking

      the ///////// response's property type changed from object to no type for status

    • breaking

      the ///////// response's property type changed from object to no type for status

    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • info

      added to the /////////// response property allOf list for the response status

    • info

      added to the /////////// response property allOf list for the response status

    • info

      added to the ///////// response property allOf list for the response status

    • info

      added to the ///////// response property allOf list for the response status

    • info

      added subschema #4 subschema #5 to the ////////// response property allOf list for the response status

    • info

      added subschema #4 subschema #5 to the //////// response property allOf list for the response status

    • info

      removed subschema #4 subschema #5 from the ////////// response property allOf list for the response status

    • info

      removed subschema #4 subschema #5 from the //////// response property allOf list for the response status

  • v2be14b3318eb3Revision changes
    • breaking

      the /// request property type changed from no type to object

    • breaking

      the /////////// response's property type changed from no type to object for status

    • breaking

      the /////////// response's property type changed from no type to object for status

    • breaking

      the ///////// response's property type changed from no type to object for status

    • breaking

      the ///////// response's property type changed from no type to object for status

    • warning

      removed subschema #2 from the /// request property allOf list

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added subschema #4 subschema #5 to the ////////// response property allOf list for the response status

    • info

      added subschema #4 subschema #5 to the //////// response property allOf list for the response status

    • info

      removed from the /////////// response property allOf list for the response status

    • info

      removed from the /////////// response property allOf list for the response status

    • info

      removed from the ///////// response property allOf list for the response status

    • info

      removed from the ///////// response property allOf list for the response status

    • info

      removed subschema #4 subschema #5 from the ////////// response property allOf list for the response status

    • info

      removed subschema #4 subschema #5 from the //////// response property allOf list for the response status

    • info

      added the required property //////////// to the response with the status

    • info

      added the required property //////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////// to the response with the status