Update a loyalty program

curl --request PUT \ --url https://api.voucherify.io/v2/loyalties/programs/{id} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'X-App-Id: <api-key>' \ --header 'X-App-Token: <api-key>' \ --data ' { "name": "<string>", "start_date": "2023-11-07T05:31:56Z", "end_date": "2023-11-07T05:31:56Z", "metadata": {} } '

{ "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>" }

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

string

required

Unique program identifier

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

Body

application/json

name

string

Program name

Required string length: 1 - 200

start_date

string<date-time> | null

Program start date (ISO 8601). Only updatable in DRAFT status.

end_date

string<date-time> | null

Program end date (ISO 8601). Only updatable in DRAFT status.

metadata

object

Custom metadata (merged with existing on update)

Response

Program updated successfully

Program DTO returned by toDTO()

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"