69be73b5cff0

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-101025471.3 MB
Programs

Update program

<Info>

<Badge color="gray">Documentation in progress</Badge>

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

</Info>

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 nullable

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

end_datestring date-time nullable

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

metadataobject nullable

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 nullable

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

end_datestring date-time nullable

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 nullable

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

object'program'

Object type marker.