v18

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

Programs

Deactivate program

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

Transitions the program to INACTIVE status. Only an ACTIVE program can be deactivated. An invalid state transition is rejected with 400 (key invalid_state_transition). No request body.

post/v2/loyalties/programs/{programId}/deactivate

Path parameters

idstring required

Unique program identifier.

Response

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