Skip to main content
PUT
Update Loyalty Campaign

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required

Scopes

api

Gives access to whole server-side API.

loyalties

Gives access to all endpoints and methods starting with /v1/loyalties.

Path Parameters

campaignId
string
required

The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

Body

application/json

Specify the new values for the parameters that you would like to update for the given loyalty campaign.

Legacy loyalty. Request body schema for PUT /loyalties/{campaignId}.

start_date
string<date-time>

Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.

Example:

"2022-09-20T00:00:00.000Z"

expiration_date
string<date-time>

Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.

Example:

"2022-09-30T00:00:00.000Z"

validity_timeframe
Validity Timeframe · object

Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.

validity_day_of_week
enum<integer>[]

Integer array corresponding to the particular days of the week in which the voucher is valid.

  • 0 Sunday
  • 1 Monday
  • 2 Tuesday
  • 3 Wednesday
  • 4 Thursday
  • 5 Friday
  • 6 Saturday
Available options:
0,
1,
2,
3,
4,
5,
6
validity_hours
Validity Hours · object

Determines the hours of validity, e.g. to create a happy hours scenario.

description
string

An optional field to keep any extra textual information about the campaign such as a campaign description and details.

category
string

The category assigned to the campaign. Either pass this parameter OR the category_id.

metadata
object

The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.

unset_metadata_fields
string[] | null

Determine which metadata should be removed from campaign.

category_id
string

Unique category ID that this campaign belongs to. Either pass this parameter OR the category.

Example:

"cat_0b688929a2476386a7"

access_settings
Access Settings · object

Assigns or unassigns an area or store to the campaign.

NOTE: this object can be sent if the Areas and Stores enterprise feature is enabled. Contact Voucherify Sales to learn more.

activity_duration_after_publishing
string

Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days.

join_once
boolean

If this value is set to true, customers will be able to join the campaign only once. It is always false for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always true for legacy loyalty campaigns and it cannot be changed in them.

auto_join
boolean

Indicates whether customers will be able to auto-join a legacy loyalty campaign if any earning rule is fulfilled.

type
enum<string>

Defines whether the campaign can be updated with new vouchers after campaign creation.

  • AUTO_UPDATE: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method).
  • STATIC: vouchers need to be manually published.

If the type of the campaign is STANDALONE, the type cannot be changed. Also, the type cannot be changed to STANDALONE.

Available options:
AUTO_UPDATE,
STATIC
loyalty_tiers_expiration
Loyalty Tiers Expiration · object

Legacy loyalty. Defines the Loyalty Tiers Expiration.

options
object

Response

Returns the loyalty campaign object if the update succeeded.

Legacy loyalty. Response body schema for PUT /loyalties/{campaignId}.

id
string
required

Unique campaign ID, assigned by Voucherify.

Example:

"camp_f7fBbQxUuTN7dI7tGOo5XMDA"

name
string
required

Campaign name.

campaign_type
enum<string>
default:LOYALTY_PROGRAM
required

Type of campaign.

Available options:
LOYALTY_PROGRAM
type
enum<string>
required

Defines whether the campaign can be updated with new vouchers after campaign creation.

  • AUTO_UPDATE: the campaign is dynamic, i.e. vouchers will generate based on set criteria
  • STATIC: vouchers need to be manually published
Available options:
AUTO_UPDATE,
STATIC
auto_join
boolean
required

Indicates whether customers will be able to auto-join a legacy loyalty campaign if any earning rule is fulfilled.

join_once
boolean
required

Always set to true for legacy loyalty campaigns, meaning customers can join the campaign only once. It can't be changed to false.

use_voucher_metadata_schema
boolean
required

Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.

created_at
string<date-time>
required

Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format.

Example:

"2021-12-01T08:00:50.038Z"

creation_status
enum<string>
required

Indicates the status of the campaign creation.

Available options:
DONE,
IN_PROGRESS,
FAILED,
DRAFT,
MODIFYING
vouchers_generation_status
enum<string>
required

Indicates the status of the campaign's voucher generation.

Available options:
DONE,
IN_PROGRESS,
FAILED,
DRAFT,
MODIFYING
protected
boolean
required

Indicates whether the resource can be deleted.

category_id
string | null
required

Unique category ID that this campaign belongs to.

Example:

"cat_0b688929a2476386a7"

categories
Category · object[]
required

Contains details about the category.

object
string
default:campaign
required

The type of the object represented by JSON. This object stores information about the campaign.

description
string

An optional field to keep any extra textual information about the campaign such as a campaign description and details.

voucher
Loyalty Campaign Voucher · object

Legacy loyalty. Schema model for a campaign voucher.

validity_timeframe
Validity Timeframe · object

Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.

validity_day_of_week
enum<integer>[]

Integer array corresponding to the particular days of the week in which the voucher is valid.

  • 0 Sunday
  • 1 Monday
  • 2 Tuesday
  • 3 Wednesday
  • 4 Thursday
  • 5 Friday
  • 6 Saturday
Available options:
0,
1,
2,
3,
4,
5,
6
validity_hours
Validity Hours · object

Determines the hours of validity, e.g. to create a happy hours scenario.

activity_duration_after_publishing
string

Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a duration of P24D will be valid for a duration of 24 days.

vouchers_count
integer

Total number of unique vouchers in campaign.

start_date
string<date-time>

Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.

Example:

"2022-09-20T00:00:00.000Z"

expiration_date
string<date-time>

Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.

Example:

"2022-09-30T00:00:00.000Z"

active
boolean

A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the start_date and expiration_date.

  • true indicates an active campaign
  • false indicates an inactive campaign
metadata
object

The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.

updated_at
string<date-time>

Timestamp representing the date and time when the campaign was last updated in ISO 8601 format.

Example:

"2022-09-20T09:18:19.623Z"

category
string

Unique category name.

readonly
boolean

Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles.

loyalty_tiers_expiration
Loyalty Tiers Expiration · object

Legacy loyalty. Defines the Loyalty Tiers Expiration.

validation_rules_assignments
Validation Rules Assignments List · object

List of Validation Rules Assignments

access_settings_assignments
Access Settings Campaign Assignments List · object

Lists all assignments of the campaign to areas and stores. For GET List Campaigns, this is returned if the expand=access_settings_assignments query parameter is passed in the request. This object is not returned for the GET Campaign summary endpoint.

NOTE: This object is returned only if the Areas and Stores enterprise feature is enabled. Contact Voucherify Sales to learn more.