v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Programs

Update program

<Warning>

<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 loyalty program. When the program is not in DRAFT status, only name and metadata may be changed (other properties are restricted after leaving draft).

put/v2/loyalties/programs/{programId}

Path parameters

idstring required

Unique program identifier.

Request body

namestring

Program name.

start_datestring date-time

Program validity start date, in ISO 8601 date-time format.

end_datestring date-time

Program validity end date, in ISO 8601 date-time format.

metadataobject

Arbitrary key-value metadata. Validated against the vl_program metadata schema definition of the project.

Example request

{
  "validity_hours": {
    "daily": [
      {
        "start_time": "09:00",
        "end_time": "17:00"
      }
    ]
  }
}

Response

The updated program.

idstring

Unique program identifier.

namestring

Program name.

status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'DELETED'

Program status.

start_datestring date-time

Program validity start date (ISO 8601), or null when not set.

end_datestring date-time

Program validity end date (ISO 8601), or null when not set.

metadataobject

Arbitrary key-value metadata. Defaults to {}.

created_atstring date-time

Creation timestamp (ISO 8601).

updated_atstring date-time

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

objectstring

Object type marker.