v18

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01934981.1 MB

Benefits

Update benefit

<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 a benefit. When the benefit is in DRAFT status all properties can be updated. When the benefit is ACTIVE, only name and stock may be updated (400 invalid_payload otherwise). Referenced resources (card definition, product/SKU, campaign) are validated the same way as on create; a points-based benefit can only reference an ACTIVE card definition (423 resource_locked otherwise). The benefit name must remain unique per project (409 duplicate_found).

put/v2/loyalties/benefits/{benefitId}

Path parameters

idstring required

Unique benefit ID, prefixed with lben_.

Request body

namestring

Benefit name. Must be unique within the project.

type'POINTS' | 'POINTS_PROPORTIONAL' | 'MATERIAL' | 'DIGITAL'

Benefit type. Determines which configuration object is required.

Response

The updated benefit

idstring required

Unique benefit ID, prefixed with lben_.

namestring required

Benefit name, unique within the project.

type'POINTS' | 'POINTS_PROPORTIONAL' | 'MATERIAL' | 'DIGITAL' required

Benefit type.

status'DRAFT' | 'ACTIVE' | 'DELETED' required

Current benefit status. DELETED appears only in the response of the delete endpoint and in activity snapshots.

created_atstring date-time required

Timestamp of when the benefit was created, in ISO 8601 format.

updated_atstring date-time nullable

Timestamp of the last update, in ISO 8601 format. Null when the benefit was never updated.

object'benefit' required

Type of the object. Always benefit.