v18

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

Benefits

Activate 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>

Moves a benefit from DRAFT to ACTIVE status. No request body. Only the DRAFT -> ACTIVE transition is allowed; activating from any other state returns 400 invalid_state_transition. A points-based benefit cannot be activated when its connected card definition does not exist or is not ACTIVE (423 resource_locked).

post/v2/loyalties/benefits/{benefitId}/activate

Path parameters

idstring required

Unique benefit ID, prefixed with lben_.

Response

The activated 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.