Delete Earning Rule

⚠️ BETA endpoint

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.

Deletes an earning rule. Cannot delete an earning rule that is assigned to a program. Returns a 409 Conflict if the rule is connected to a program.

DELETE /v2/loyalties/earning-rules/{id}

Delete Earning Rule

cURL

curl --request DELETE \
  --url https://api.voucherify.io/v2/loyalties/earning-rules/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "id": "<string>",
  "name": "<string>",
  "earnings": [
    {
      "name": "<string>",
      "rules": {
        "logic": "<string>"
      },
      "effects": [
        {
          "points": {
            "value": 123,
            "card_definition_id": "<string>",
            "points_expiration": {
              "rolling_expiration": {
                "period": {
                  "value": 2
                },
                "rounding": {
                  "value": 6
                }
              },
              "calendar_expiration": {
                "expiration_dates": [
                  {
                    "day": 16,
                    "month": 6
                  }
                ]
              },
              "sliding_expiration": {
                "earning_activity": true,
                "spending_activity": true,
                "custom_activity": true,
                "custom_activity_types": [
                  "<string>"
                ],
                "period": {
                  "value": 2
                }
              }
            }
          },
          "points_proportional": {
            "card_definition_id": "<string>",
            "order": {
              "amount": {
                "every": 123,
                "value": 123
              },
              "total_amount": {
                "every": 123,
                "value": 123
              },
              "metadata": {
                "every": 123,
                "value": 123,
                "property": "<string>"
              }
            },
            "customer": {
              "metadata": {
                "every": 123,
                "value": 123,
                "property": "<string>"
              }
            },
            "order_items": {
              "amount": {
                "every": 123,
                "value": 123,
                "applicable_to": [
                  {
                    "product": {
                      "id": "<string>"
                    },
                    "sku": {
                      "id": "<string>"
                    },
                    "products_collection": {
                      "id": "<string>"
                    }
                  }
                ]
              },
              "subtotal_amount": {
                "every": 123,
                "value": 123,
                "applicable_to": [
                  {
                    "product": {
                      "id": "<string>"
                    },
                    "sku": {
                      "id": "<string>"
                    },
                    "products_collection": {
                      "id": "<string>"
                    }
                  }
                ]
              },
              "quantity": {
                "every": 123,
                "value": 123,
                "applicable_to": [
                  {
                    "product": {
                      "id": "<string>"
                    },
                    "sku": {
                      "id": "<string>"
                    },
                    "products_collection": {
                      "id": "<string>"
                    }
                  }
                ]
              }
            },
            "points_expiration": {
              "rolling_expiration": {
                "period": {
                  "value": 2
                },
                "rounding": {
                  "value": 6
                }
              },
              "calendar_expiration": {
                "expiration_dates": [
                  {
                    "day": 16,
                    "month": 6
                  }
                ]
              },
              "sliding_expiration": {
                "earning_activity": true,
                "spending_activity": true,
                "custom_activity": true,
                "custom_activity_types": [
                  "<string>"
                ],
                "period": {
                  "value": 2
                }
              }
            }
          },
          "incentive": {
            "id": "<string>"
          }
        }
      ]
    }
  ],
  "trigger": {
    "custom_event": {
      "schema_id": "<string>"
    },
    "segment": {
      "id": "<string>"
    }
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "object": "<string>",
  "error": {
    "message": "<string>"
  },
  "validity_hours": {
    "daily": [
      {
        "days_of_week": [
          123
        ],
        "start_time": "<string>",
        "end_time": "<string>"
      }
    ]
  },
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "trigger_limits": {
    "cooldown": {
      "fixed_cooldown": {
        "period": {
          "value": 123
        }
      }
    },
    "frequency": {
      "limits": [
        {
          "type": "TIME_BASED",
          "period": {
            "type": "CURRENT_PERIOD",
            "current_period": {}
          },
          "triggers": {
            "max": 123
          }
        }
      ]
    }
  },
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 409,
  "key": "non_draft_program",
  "message": "Invalid vl_program status",
  "details": "Cannot modify card definition assignment when program status is not DRAFT"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

id · string · required

Unique earning rule identifier.

Response

200

application/json

Earning rule deleted successfully.

id · string · required

Unique earning rule identifier.

name · string · required

status · enum<string> · required

Available options: DRAFT, ACTIVE, INACTIVE, DELETED

earnings · object[] · required

Show child attributes

trigger · object · required

Show child attributes

metadata · object · required

created_at · string<date-time> · required

object · string · required

Allowed value: "earning_rule"

error · object | null

Show child attributes

validity_hours · object | null

Show child attributes

start_date · string<date-time> | null

end_date · string<date-time> | null

trigger_limits · object | null

Show child attributes

updated_at · string<date-time> | null