Delete a loyalty program

⚠️ BETA endpoint

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.

Soft-deletes a loyalty program and all its assignments (card definitions, earning rules, rewards, tier structures).

DELETE /v2/loyalties/programs/{id}

Delete a loyalty program

cURL

curl --request DELETE \
  --url https://api.voucherify.io/v2/loyalties/programs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "id": "<string>",
  "name": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "object": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

id · string · required

Unique program identifier

Pattern: ^lprg_[a-f0-9]+$

Response

200

application/json

Program deleted successfully

Program DTO returned by toDTO()

id · string

Unique program identifier

Pattern: ^lprg_[a-f0-9]+$

name · string

Program name

status · enum<string>

Available options: DRAFT, ACTIVE, INACTIVE, DELETED

start_date · string<date-time> | null

Program start date

end_date · string<date-time> | null

Program end date

metadata · object

Custom key-value metadata.

created_at · string<date-time>

Creation timestamp (ISO 8601)

updated_at · string<date-time> | null

Last update timestamp (ISO 8601)

object · string

Allowed value: "program"