voucherify.CampaignsApi

All URIs are relative to https://api.voucherify.io

Method	HTTP request	Description
add_voucher_with_specific_code_to_campaign	POST /v1/campaigns/{campaignId}/vouchers/{code}	Add Voucher with Specific Code to Campaign
add_vouchers_to_campaign	POST /v1/campaigns/{campaignId}/vouchers	Add Vouchers to Campaign
create_campaign	POST /v1/campaigns	Create Campaign
delete_campaign	DELETE /v1/campaigns/{campaignId}	Delete Campaign
disable_campaign	POST /v1/campaigns/{campaignId}/disable	Disable Campaign
enable_campaign	POST /v1/campaigns/{campaignId}/enable	Enable Campaign
export_campaign_transactions	POST /v1/campaigns/{campaignId}/transactions/export	Export Campaign Transactions
get_campaign	GET /v1/campaigns/{campaignId}	Get Campaign
get_campaign_summary	GET /v1/campaigns/{campaignId}/summary	Get Campaign Summary
import_vouchers_to_campaign	POST /v1/campaigns/{campaignId}/import	Import Vouchers to Campaign
import_vouchers_to_campaign_using_csv	POST /v1/campaigns/{campaignId}/importCSV	Import Vouchers to Campaign by CSV
list_campaign_transactions	GET /v1/campaigns/{campaignId}/transactions	List Campaign Transactions
list_campaigns	GET /v1/campaigns	List Campaigns
update_campaign	PUT /v1/campaigns/{campaignId}	Update Campaign

add_voucher_with_specific_code_to_campaign

CampaignsVouchersCreateResponseBody add_voucher_with_specific_code_to_campaign(campaign_id, code, campaigns_vouchers_create_request_body=campaigns_vouchers_create_request_body)

Add Voucher with Specific Code to Campaign

This method gives a possibility to add a new voucher to an existing campaign. The voucher definition will be inherited from the definition kept in the campaign profile. However, you are able to overwrite a few properties inherited from the campaign.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.models.campaigns_vouchers_create_request_body import CampaignsVouchersCreateRequestBody
from voucherify.models.campaigns_vouchers_create_response_body import CampaignsVouchersCreateResponseBody
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str | The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
    code = 'code_example' # str | A custom **code** that identifies the voucher.
    campaigns_vouchers_create_request_body = {"category_id":"cat_0bb81a481615a37b5e","start_date":"2022-09-24T00:00:00Z","expiration_date":"2022-09-25T23:59:59Z","active":false,"redemption":{"quantity":null},"additional_info":"Voucher added using API","metadata":{"Season":"Fall"}} # CampaignsVouchersCreateRequestBody | Specify the voucher parameters that you would like to overwrite. (optional)

    try:
        # Add Voucher with Specific Code to Campaign
        api_response = api_instance.add_voucher_with_specific_code_to_campaign(campaign_id, code, campaigns_vouchers_create_request_body=campaigns_vouchers_create_request_body)
        print("The response of CampaignsApi->add_voucher_with_specific_code_to_campaign:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->add_voucher_with_specific_code_to_campaign: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	str	The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
code	str	A custom code that identifies the voucher.
campaigns_vouchers_create_request_body	CampaignsVouchersCreateRequestBody	Specify the voucher parameters that you would like to overwrite.	[optional]

Return type

CampaignsVouchersCreateResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns a voucher object if the call succeeded.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

add_vouchers_to_campaign

CampaignsVouchersCreateCombinedResponseBody add_vouchers_to_campaign(campaign_id, vouchers_count=vouchers_count, campaigns_vouchers_create_in_bulk_request_body=campaigns_vouchers_create_in_bulk_request_body)

Add Vouchers to Campaign

This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional code_config parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.models.campaigns_vouchers_create_combined_response_body import CampaignsVouchersCreateCombinedResponseBody
from voucherify.models.campaigns_vouchers_create_in_bulk_request_body import CampaignsVouchersCreateInBulkRequestBody
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str | The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
    vouchers_count = 56 # int | Number of vouchers that should be added. (optional)
    campaigns_vouchers_create_in_bulk_request_body = voucherify.CampaignsVouchersCreateInBulkRequestBody() # CampaignsVouchersCreateInBulkRequestBody | Specify the voucher parameters that you would like to overwrite. (optional)

    try:
        # Add Vouchers to Campaign
        api_response = api_instance.add_vouchers_to_campaign(campaign_id, vouchers_count=vouchers_count, campaigns_vouchers_create_in_bulk_request_body=campaigns_vouchers_create_in_bulk_request_body)
        print("The response of CampaignsApi->add_vouchers_to_campaign:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->add_vouchers_to_campaign: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	str	The campaign ID or name of the campaign to which voucher(s) will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
vouchers_count	int	Number of vouchers that should be added.	[optional]
campaigns_vouchers_create_in_bulk_request_body	CampaignsVouchersCreateInBulkRequestBody	Specify the voucher parameters that you would like to overwrite.	[optional]

Return type

CampaignsVouchersCreateCombinedResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns a voucher object if the call succeeded for a voucher count of 1. and Returns an `async_action_id` if the request was made to create more than 1 voucher.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_campaign

CampaignsCreateResponseBody create_campaign(campaigns_create_request_body=campaigns_create_request_body)

Create Campaign

Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. 📘 Global uniqueness All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code. 🚧 Code generation status This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the campaign object description. 🚧 Standalone Vouchers and Campaigns In version v20241004, generic (standalone) voucherss created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the Voucherify Release Notes for more details about released features.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.models.campaigns_create_request_body import CampaignsCreateRequestBody
from voucherify.models.campaigns_create_response_body import CampaignsCreateResponseBody
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaigns_create_request_body = {"name":"Discount Campaign 4","campaign_type":"DISCOUNT_COUPONS","join_once":true,"type":"AUTO_UPDATE","start_date":"2020-08-16T00:00:00Z","expiration_date":"2023-12-26T00:00:00Z","vouchers_count":3,"voucher":{"type":"DISCOUNT_VOUCHER","discount":{"percent_off":10,"type":"PERCENT"},"redemption":{"quantity":10},"code_config":{"pattern":"10OFF-#######"}},"validity_timeframe":{"interval":"P2D","duration":"P1D"},"validity_day_of_week":[0,1,2],"activity_duration_after_publishing":"P24D","use_voucher_metadata_schema":false,"metadata":{"region":"AMER"}} # CampaignsCreateRequestBody | Specify the details of the campaign that you would like to create. (optional)

    try:
        # Create Campaign
        api_response = api_instance.create_campaign(campaigns_create_request_body=campaigns_create_request_body)
        print("The response of CampaignsApi->create_campaign:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->create_campaign: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaigns_create_request_body	CampaignsCreateRequestBody	Specify the details of the campaign that you would like to create.	[optional]

Return type

CampaignsCreateResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns a campaign object if the call succeeded.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_campaign

CampaignsDeleteResponseBody delete_campaign(campaign_id, force=force)

Delete Campaign

Deletes a campaign and all related vouchers. This action cannot be undone. Also, this method immediately removes any redemptions on the voucher. If the force parameter is set to false or not set at all, the campaign and all related vouchers will be moved to the bin. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.models.campaigns_delete_response_body import CampaignsDeleteResponseBody
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
    force = True # bool | If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the campaign and related vouchers will be moved to the bin. Going forward, the user will be able to create the next campaign with exactly the same name. (optional)

    try:
        # Delete Campaign
        api_response = api_instance.delete_campaign(campaign_id, force=force)
        print("The response of CampaignsApi->delete_campaign:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->delete_campaign: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	str	You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
force	bool	If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the campaign and related vouchers will be moved to the bin. Going forward, the user will be able to create the next campaign with exactly the same name.	[optional]

Return type

CampaignsDeleteResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns the ID of the scheduled asynchronous action, informing you that your request has been accepted and the campaign will be deleted from the repository asynchronously. To check the deletion status and result, copy the `async_action_id` from the response and pass it using <!-- Get Async Action -->Get Async Action endpoint.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disable_campaign

object disable_campaign(campaign_id)

Disable Campaign

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str | The campaign ID or name of the campaign being disabled. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.

    try:
        # Disable Campaign
        api_response = api_instance.disable_campaign(campaign_id)
        print("The response of CampaignsApi->disable_campaign:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->disable_campaign: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	str	The campaign ID or name of the campaign being disabled. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.

Return type

object

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns an empty json `{}`.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_campaign

object enable_campaign(campaign_id)

Enable Campaign

There are various times when youll want to manage a campaigns accessibility. This can be done by two API methods for managing the campaign state - enable and disable. Sets campaign state to active. The vouchers in this campaign can be redeemed - only if the redemption occurs after the start date of the campaign and voucher and the voucher and campaign are not expired.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str | The campaign ID or name of the campaign being enabled. You can either pass the campaign ID, which was assigned by Voucherify or the name of the campaign as the path parameter value.

    try:
        # Enable Campaign
        api_response = api_instance.enable_campaign(campaign_id)
        print("The response of CampaignsApi->enable_campaign:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->enable_campaign: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	str	The campaign ID or name of the campaign being enabled. You can either pass the campaign ID, which was assigned by Voucherify or the name of the campaign as the path parameter value.

Return type

object

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns an empty json `{}`.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

export_campaign_transactions

CampaignsTransactionsExportCreateResponseBody export_campaign_transactions(campaign_id, campaigns_transactions_export_create_request_body=campaigns_transactions_export_create_request_body)

Export Campaign Transactions

Export transactions is an asynchronous process that generates a CSV file with the data about credit movements on all gift cards or point movements on all loyalty cards in a given campaign. To export transactions: 1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered. 2. Use the returned id to track the export status with the GET Export method. 3. In the GET Export method, when the returned status field has the DONE value, the export file has been generated. 4. Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file. An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files. An example export file can look as follows: 👍 Export Loyalty Campaign Transactions For loyalty campaigns, this method works in the same way the POST Export Loyalty Campaign Transactions does.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.models.campaigns_transactions_export_create_request_body import CampaignsTransactionsExportCreateRequestBody
from voucherify.models.campaigns_transactions_export_create_response_body import CampaignsTransactionsExportCreateResponseBody
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
    campaigns_transactions_export_create_request_body = {"order":"-created_at","parameters":{"fields":["id","type","source_id","created_at"],"filters":{"created_at":{"conditions":{"$after":["2024-10-01T00:00:00.000Z"]}}}}} # CampaignsTransactionsExportCreateRequestBody | Specify the parameters for the transaction export. (optional)

    try:
        # Export Campaign Transactions
        api_response = api_instance.export_campaign_transactions(campaign_id, campaigns_transactions_export_create_request_body=campaigns_transactions_export_create_request_body)
        print("The response of CampaignsApi->export_campaign_transactions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->export_campaign_transactions: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	str	You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
campaigns_transactions_export_create_request_body	CampaignsTransactionsExportCreateRequestBody	Specify the parameters for the transaction export.	[optional]

Return type

CampaignsTransactionsExportCreateResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	An object representing an export.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_campaign

CampaignsGetResponseBody get_campaign(campaign_id)

Get Campaign

Retrieves the campaign with the given campaign ID or campaign name.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.models.campaigns_get_response_body import CampaignsGetResponseBody
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.

    try:
        # Get Campaign
        api_response = api_instance.get_campaign(campaign_id)
        print("The response of CampaignsApi->get_campaign:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->get_campaign: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	str	You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.

Return type

CampaignsGetResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns a campaign object if a valid identifier was provided.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_campaign_summary

CampaignsSummaryGetResponseBody get_campaign_summary(campaign_id, start_date=start_date, end_date=end_date)

Get Campaign Summary

Returns data for campaign analytics, covering validations, redemptions, publications, and other details specific to a given campaign type. Use start_date and end_date to narrow down the data to specific periods. 🚧 Campaigns created before v20250602 version This endpoint returns analytics data for campaigns that were created after the v20250602 version was released on 17 June 2025. Older campaigns return empty data.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.models.campaigns_summary_get_response_body import CampaignsSummaryGetResponseBody
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
    start_date = '2013-10-20' # date | Timestamp representing the date which results must begin on. Represented in ISO 8601 format. (optional)
    end_date = '2013-10-20' # date | Timestamp representing the date which results must end on. Represented in ISO 8601 format. (optional)

    try:
        # Get Campaign Summary
        api_response = api_instance.get_campaign_summary(campaign_id, start_date=start_date, end_date=end_date)
        print("The response of CampaignsApi->get_campaign_summary:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->get_campaign_summary: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	str	You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
start_date	date	Timestamp representing the date which results must begin on. Represented in ISO 8601 format.	[optional]
end_date	date	Timestamp representing the date which results must end on. Represented in ISO 8601 format.	[optional]

Return type

CampaignsSummaryGetResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns campaign analytics data. Returns different data depending on the campaign type.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

import_vouchers_to_campaign

CampaignsImportCreateResponseBody import_vouchers_to_campaign(campaign_id, campaigns_import_voucher_item=campaigns_import_voucher_item)

Import Vouchers to Campaign

Imports vouchers to an existing campaign. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.models.campaigns_import_create_response_body import CampaignsImportCreateResponseBody
from voucherify.models.campaigns_import_voucher_item import CampaignsImportVoucherItem
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str | The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
    campaigns_import_voucher_item = [{"code":"CODE7","category":"First","redemption":{"quantity":1},"metadata":{"season":"Fall"},"additional_info":"secret-code1","active":true},{"code":"CODE8","category":"Second","redemption":{"quantity":18},"metadata":{"season":"Fall"},"additional_info":"secret-code1","active":true},{"code":"CODE9","redemption":{"quantity":4},"metadata":{"season":"Fall"},"additional_info":"secret-code1","active":true}] # List[CampaignsImportVoucherItem] | Discount type, expiration date and the remaining attributes will be taken from the Campaign settings. (optional)

    try:
        # Import Vouchers to Campaign
        api_response = api_instance.import_vouchers_to_campaign(campaign_id, campaigns_import_voucher_item=campaigns_import_voucher_item)
        print("The response of CampaignsApi->import_vouchers_to_campaign:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->import_vouchers_to_campaign: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	str	The ID of an existing campaign to which youre importing the codes. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
campaigns_import_voucher_item	List[CampaignsImportVoucherItem]	Discount type, expiration date and the remaining attributes will be taken from the Campaign settings.	[optional]

Return type

CampaignsImportCreateResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns the ID of the scheduled asynchronous action, informing you that your request has been accepted and the vouchers will be imported to the repository asynchronously. To check the status and result, copy the `async_action_id` from the response and pass it using <!-- Get Async Action -->Get Async Action endpoint.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

import_vouchers_to_campaign_using_csv

CampaignsImportCsvCreateResponseBody import_vouchers_to_campaign_using_csv(campaign_id, file=file)

Import Vouchers to Campaign by CSV

Imports vouchers to an existing campaign. The CSV file has to include headers in the first line. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.models.campaigns_import_csv_create_response_body import CampaignsImportCsvCreateResponseBody
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str | The campaign ID or name of the campaign being enabled. You can either pass the campaign ID, which was assigned by Voucherify or the name of the campaign as the path parameter value.
    file = None # bytearray | File path. (optional)

    try:
        # Import Vouchers to Campaign by CSV
        api_response = api_instance.import_vouchers_to_campaign_using_csv(campaign_id, file=file)
        print("The response of CampaignsApi->import_vouchers_to_campaign_using_csv:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->import_vouchers_to_campaign_using_csv: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	str	The campaign ID or name of the campaign being enabled. You can either pass the campaign ID, which was assigned by Voucherify or the name of the campaign as the path parameter value.
file	bytearray	File path.	[optional]

Return type

CampaignsImportCsvCreateResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns the ID of the scheduled asynchronous action, informing you that your request has been accepted and the vouchers will be imported to the repository asynchronously. To check the status and result, copy the `async_action_id` from the response and pass it using <!-- Get Async Action -->Get Async Action endpoint.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_campaign_transactions

CampaignsTransactionsListResponseBody list_campaign_transactions(campaign_id, limit=limit, order=order, starting_after_id=starting_after_id, filters=filters)

List Campaign Transactions

Retrieves all transactions for the campaign with the given campaign ID or campaign name. The id filter denotes the unique transaction identifier. 🚧 The endpoint works only for gift card and loyalty campaigns.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.models.campaigns_transactions_list_response_body import CampaignsTransactionsListResponseBody
from voucherify.models.parameter_order_list_transactions import ParameterOrderListTransactions
from voucherify.models.parameters_filters_list_campaign_transactions import ParametersFiltersListCampaignTransactions
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
    limit = 56 # int | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)
    order = voucherify.ParameterOrderListTransactions() # ParameterOrderListTransactions | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
    starting_after_id = 'starting_after_id_example' # str | A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. (optional)
    filters = voucherify.ParametersFiltersListCampaignTransactions() # ParametersFiltersListCampaignTransactions | Filters for listing responses. (optional)

    try:
        # List Campaign Transactions
        api_response = api_instance.list_campaign_transactions(campaign_id, limit=limit, order=order, starting_after_id=starting_after_id, filters=filters)
        print("The response of CampaignsApi->list_campaign_transactions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->list_campaign_transactions: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	str	You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
limit	int	Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.	[optional]
order	ParameterOrderListTransactions	Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.	[optional]
starting_after_id	str	A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.	[optional]
filters	ParametersFiltersListCampaignTransactions	Filters for listing responses.	[optional]

Return type

CampaignsTransactionsListResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns a dictionary with a `data` property that contains an array of transactions. The maximum number of transactions returned is determined by the `limit` query parameter. Each entry in the array is a separate transaction object. If more results are available, the `has_more` flag has value `true` and the value of the `more_starting_after` property can be used to retrieve another page of results.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_campaigns

CampaignsListResponseBody list_campaigns(limit=limit, page=page, campaign_type=campaign_type, expand=expand, campaign_status=campaign_status, is_referral_code=is_referral_code, order=order, filters=filters, access_settings=access_settings)

List Campaigns

Retrieve a list of campaigns in a project. The campaigns are returned sorted by creation date, with the most recent campaigns appearing first. When you get a list of campaigns, you can optionally specify query parameters to customize the amount of campaigns returned per call using limit, which page of campaigns to return using page, sort the campaigns using the order query parameter and filter the results by the campaign_type. This method will return an error when trying to return a limit of more than 100 campaigns.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.models.campaigns_list_response_body import CampaignsListResponseBody
from voucherify.models.parameter_campaign_status_list_campaigns import ParameterCampaignStatusListCampaigns
from voucherify.models.parameter_campaign_type import ParameterCampaignType
from voucherify.models.parameter_campaigns_access_setttings import ParameterCampaignsAccessSetttings
from voucherify.models.parameter_expand_list_campaigns import ParameterExpandListCampaigns
from voucherify.models.parameter_filters_list_campaigns import ParameterFiltersListCampaigns
from voucherify.models.parameter_order_list_campaigns import ParameterOrderListCampaigns
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    limit = 56 # int | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)
    page = 56 # int | Which page of results to return. The lowest value is 1. (optional)
    campaign_type = voucherify.ParameterCampaignType() # ParameterCampaignType | This attribute allows filtering by campaign type. (optional)
    expand = voucherify.ParameterExpandListCampaigns() # ParameterExpandListCampaigns | Includes an expanded categories object in the response. If the [Areas and Stores](https://support.voucherify.io/article/623-areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores. (optional)
    campaign_status = voucherify.ParameterCampaignStatusListCampaigns() # ParameterCampaignStatusListCampaigns | Sorts the results by the status of the campaign. (optional)
    is_referral_code = True # bool | Sorts the results that are or are not referral campaigns. (optional)
    order = voucherify.ParameterOrderListCampaigns() # ParameterOrderListCampaigns | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
    filters = voucherify.ParameterFiltersListCampaigns() # ParameterFiltersListCampaigns | Filters the results by various campaign properties. (optional)
    access_settings = voucherify.ParameterCampaignsAccessSetttings() # ParameterCampaignsAccessSetttings | Filter by areas and stores IDs to return campaigns that are assigned to areas, stores, and all stores in an area. (optional)

    try:
        # List Campaigns
        api_response = api_instance.list_campaigns(limit=limit, page=page, campaign_type=campaign_type, expand=expand, campaign_status=campaign_status, is_referral_code=is_referral_code, order=order, filters=filters, access_settings=access_settings)
        print("The response of CampaignsApi->list_campaigns:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->list_campaigns: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int	Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.	[optional]
page	int	Which page of results to return. The lowest value is 1.	[optional]
campaign_type	ParameterCampaignType	This attribute allows filtering by campaign type.	[optional]
expand	ParameterExpandListCampaigns	Includes an expanded categories object in the response. If the Areas and Stores Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores.	[optional]
campaign_status	ParameterCampaignStatusListCampaigns	Sorts the results by the status of the campaign.	[optional]
is_referral_code	bool	Sorts the results that are or are not referral campaigns.	[optional]
order	ParameterOrderListCampaigns	Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.	[optional]
filters	ParameterFiltersListCampaigns	Filters the results by various campaign properties.	[optional]
access_settings	ParameterCampaignsAccessSetttings	Filter by areas and stores IDs to return campaigns that are assigned to areas, stores, and all stores in an area.	[optional]

Return type

CampaignsListResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns a dictionary with a `campaign` property that contains an array of campaigns. The maximum number of campaigns returned is determined by the `limit` query parameter. Each entry in the array is a separate campaign object. If no more campaigns are available, the resulting array on a given page will be empty.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_campaign

CampaignsUpdateResponseBody update_campaign(campaign_id, campaigns_update_request_body=campaigns_update_request_body)

Update Campaign

Updates the specified campaign by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. Fields other than the ones listed in the request body wont be modified. Even if provided, they will be silently skipped. ## Vouchers will be affected This method will update vouchers aggregated in the campaign. It will affect all vouchers that are not published or redeemed yet.

Example

Api Key Authentication (X-App-Id):
Api Key Authentication (X-App-Token):

import voucherify
from voucherify.models.campaigns_update_request_body import CampaignsUpdateRequestBody
from voucherify.models.campaigns_update_response_body import CampaignsUpdateResponseBody
from voucherify.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify.Configuration(
    host = "https://api.voucherify.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'

# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with voucherify.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = voucherify.CampaignsApi(api_client)
    campaign_id = 'campaign_id_example' # str | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
    campaigns_update_request_body = {"description":"New description"} # CampaignsUpdateRequestBody | Specify the campaign parameters to be updated. (optional)

    try:
        # Update Campaign
        api_response = api_instance.update_campaign(campaign_id, campaigns_update_request_body=campaigns_update_request_body)
        print("The response of CampaignsApi->update_campaign:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CampaignsApi->update_campaign: %s\n" % e)

Parameters

Name	Type	Description	Notes
campaign_id	str	You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
campaigns_update_request_body	CampaignsUpdateRequestBody	Specify the campaign parameters to be updated.	[optional]

Return type

CampaignsUpdateResponseBody

Authorization

X-App-Id, X-App-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	Returns the campaign object if the update succeeded.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

CampaignsApi.md

Latest commit

History

CampaignsApi.md

File metadata and controls

voucherify.CampaignsApi

add_voucher_with_specific_code_to_campaign

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_vouchers_to_campaign

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_campaign

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_campaign

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

disable_campaign

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

enable_campaign

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

export_campaign_transactions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_campaign

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_campaign_summary

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

import_vouchers_to_campaign

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

import_vouchers_to_campaign_using_csv

Example

Parameters