Skip to main content
PUT
/
v1
/
campaigns
/
{campaignId}
Update Campaign
curl --request PUT \
  --url https://{cluster}.voucherify.io/v1/campaigns/{campaignId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "description": "New description"
}'
{
  "id": "camp_FZL4iTTdZw36nZOoXYQ172fQ",
  "name": "Loyalty Campaign",
  "campaign_type": "LOYALTY_PROGRAM",
  "type": "AUTO_UPDATE",
  "voucher": {
    "type": "LOYALTY_CARD",
    "loyalty_card": {
      "points": 1000,
      "expiration_rules": {
        "period_type": "MONTH",
        "period_value": 3,
        "rounding_type": "END_OF_YEAR"
      }
    },
    "redemption": {
      "quantity": 10
    },
    "code_config": {
      "length": 7,
      "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
      "pattern": "LOYALTY-CARD-#######"
    },
    "is_referral_code": false,
    "start_date": "2020-08-16T00:00:00.000Z",
    "expiration_date": "2023-12-26T00:00:00.000Z",
    "validity_timeframe": {
      "interval": "P2D",
      "duration": "P1D"
    }
  },
  "auto_join": false,
  "join_once": false,
  "use_voucher_metadata_schema": false,
  "description": "New description",
  "start_date": "2020-08-16T00:00:00.000Z",
  "expiration_date": "2023-12-26T00:00:00.000Z",
  "validity_timeframe": {
    "interval": "P2D",
    "duration": "P1D"
  },
  "validity_day_of_week": [
    0,
    1,
    2
  ],
  "activity_duration_after_publishing": "P24D",
  "vouchers_count": 2,
  "active": true,
  "metadata": {
    "region": "APAC"
  },
  "created_at": "2022-09-21T09:39:45.479Z",
  "updated_at": "2022-09-23T09:47:00.205Z",
  "category": "First",
  "creation_status": "MODIFYING",
  "vouchers_generation_status": "MODIFYING",
  "protected": false,
  "validation_rules_assignments": {
    "object": "list",
    "data_ref": "data",
    "data": [],
    "total": 0
  },
  "category_id": "cat_0bb343dee3cdb5ec0c",
  "categories": [
    {
      "id": "cat_0bb343dee3cdb5ec0c",
      "name": "First",
      "hierarchy": 1,
      "created_at": "2022-09-16T11:47:19.568Z",
      "object": "category"
    }
  ],
  "object": "campaign"
}

Authorizations

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

Path Parameters

campaignId
string
required
Example:

Body

application/json
  • Properties For Discount Coupons Campaign
  • Properties For Referral Campaign
  • Properties For Gift Campaign
  • Properties For Loyalty Campaign
  • Update Promotion Campaign
discount
object
  • Amount
  • Unit
  • Unit Multiple
  • Percent
  • Fixed
start_date
string<date-time>
Example:
expiration_date
string<date-time>
Example:
validity_timeframe
object
validity_day_of_week
enum<integer>[]
validity_hours
object
description
string
category
string
metadata
object
unset_metadata_fields
string[] | null
category_id
string
Example:
access_settings
object
activity_duration_after_publishing
string
join_once
boolean
auto_join
boolean
type
enum<string>
Available options:
AUTO_UPDATE,
STATIC

Response

id
string
required
Example:
name
string
required
campaign_type
enum<string>
required
Available options:
LOYALTY_PROGRAM,
GIFT_VOUCHERS,
DISCOUNT_COUPONS,
PROMOTION,
REFERRAL_PROGRAM
type
enum<string>
required
Available options:
AUTO_UPDATE,
STATIC,
STANDALONE
auto_join
boolean
required
join_once
boolean
required
use_voucher_metadata_schema
boolean
required
created_at
string<date-time>
required
Example:
creation_status
enum<string>
required
Available options:
DONE,
IN_PROGRESS,
FAILED,
DRAFT,
MODIFYING
vouchers_generation_status
enum<string>
required
Available options:
DONE,
IN_PROGRESS,
FAILED,
DRAFT,
MODIFYING
protected
boolean
required
category_id
string | null
required
Example:
categories
Category · object[]
required
object
string
default:campaign
required
description
string
voucher
object
validity_timeframe
object
validity_day_of_week
enum<integer>[]
validity_hours
object
activity_duration_after_publishing
string
vouchers_count
integer
start_date
string<date-time>
Example:
expiration_date
string<date-time>
Example:
active
boolean
metadata
object
updated_at
string<date-time>
Example:
category
string
readonly
boolean
referral_program
object
loyalty_tiers_expiration
object
access_settings_assignments
object
promotion
object
validation_rules_assignments
object