patch-api2-dashboard-offers-redeemable

Update Redeemable

​

Allows a business to update one or more redeemables. You can bulk update a maximum of 20 redeemables per API call. If the request input contains more than 20 redeemables, only the first 20 are created, and the remaining are ignored.

For more information, see Offers Ingestion Management

PATCH Requests: Partial Updates and Nested Object Replacements

PATCH requests allow you to update specific parameters of a Redeemable object without affecting others. You only need to include the parameters you want to modify. For example, you can update only the allow_for_support_gifting parameter in a Redeemable object.

When updating a nested object (e.g., receipt_rule, template, lag_duration, recurrence_schedule), the entire nested object is replaced with the valid values provided in the request. Invalid values are ignored.

Additional rules when updating nested objects:

  • If all provided values are invalid, the existing values remain unchanged.
  • If an empty nested object is provided, the existing values are deleted.
  • If the nested object or any of its parameters is omitted, existing values remain unaffected.

To call this API, the offers ingestion option must be enabled for the business on the Punchh platform. Contact your Punchh representative to update this Punchh platform configuration.

For more information on Redeemable settings, see the Redeemables article on the Support Portal.

Note: To view the Punchh product documentation on the Punchh Support Portal, you must log in to a Punchh platform production environment. If you already have access to a production environment, follow the instructions here to access the Punchh Support Portal.

Headers
  • Accept
    Type: string

    Set this header to application/json

  • Authorization
    Type: string
    required

    Bearer token for admin authorization, who is making a call on behalf of the customer. Send the API key in the following format: "Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE".

  • Content-Type
    Type: string

    Set this header to application/json

Body
application/json
  • data
    Type: array object[]
    required

    A list of redeemables that needs to be created

Responses
  • 200
    Type: Redeemable - Results (Array Object)
    • results
      Type: array object[]

      List of responses indicating if the entity is created or not

  • 400
    Type: object
    • error
      Type: string
  • 401
    Type: object
    • error
      Type: string
  • 403
    Type: object
    • error
      Type: string
patch/api2/dashboard/offers/redeemable
{
  "results": [
    {
      "external_id": "string",
      "success": true,
      "errors": [
        "string"
      ],
      "warnings": {
        "receipt_rule": {
          "redeeming_criterion": {
            "line_item_filters": [
              {
                "message": "string",
                "item": {
                  "line_item_selector_id": "string",
                  " processing_method": "string",
                  "quantity": 1
                }
              }
            ],
            "item_qualifiers": [
              {
                "message": "string",
                "item": {
                  "line_item_selector_id": "string",
                  "expression_type": "string",
                  "net_value": 1
                }
              }
            ],
            "receipt_qualifiers": [
              {
                "message": "string",
                "item": {
                  "attribute": "string",
                  "operator": "string",
                  "value": "string"
                }
              }
            ],
            "qualifying_expressions_operator": [
              {
                "message": "string",
                "item": {
                  "qualifying_expressions_operator": "string"
                }
              }
            ],
            "item_filter_expressions_operator": [
              {
                "message": "string",
                "item": {
                  "item_filter_expressions_operator": "string"
                }
              }
            ],
            "discount_evaluation_strategy": [
              {
                "message": "string",
                "item": {
                  "discount_evaluation_strategy": "string"
                }
              }
            ]
          }
        }
      }
    }
  ]
}

OK - Success