Create Project

post https://{cluster}.voucherify.io/management/v1/projects

Creates a new project. You can add users, specify the cluster, timezone, currency, and other details.

All owners are added to the project by default.

Body Params

Define project details.

case_sensitive_codes

boolean

required

Determines if the vouchers in the project will be case sensitive (if true, C0dE-cfV is not equal to c0de-cfv) or case insensitive (if false, C0dE-cfV is equal to c0de-cfv).

name

string

required

The name of the project.

description

string

A user-defined description of the project, e.g. its purpose, scope, region.

timezone

string

required

The time zone in which the project is established. It can be in the GMT format or in accordance with IANA time zone database.

currency

string

required

The currency used in the project. It is equal to a 3-letter ISO 4217 code.

dial_code

string | null

The country dial code for the project. It is equal to an ITU country code.

webhook_version

string

Defaults to v2024-01-01

The webhook version used in the project.

client_trusted_domains

array of strings

An array of URL addresses that allow client requests.

client_trusted_domains

client_redeem_enabled

boolean

Enables client-side redemption.

client_publish_enabled

boolean

Enables client-side publication.

client_list_vouchers_enabled

boolean

Enables client-side listing of vouchers.

client_create_customer_enabled

boolean

Enables client-side creation of customers.

client_loyalty_events_enabled

boolean

Enables client-side events for loyalty and referral programs.

client_set_voucher_expiration_date_enabled

boolean

Enables client-side setting of voucher expiration date.

webhooks_callout_notifications

object

Determines the notification settings for webhook callouts configured in Distributions and Project settings.

api_usage_notifications

object

Determines the notification settings.

cluster_id

string

The identifier of the cluster where the project will be created. The default cluster is eu1 unless otherwise configured.

api_version

string

Defaults to v2018-08-01

The API version used in the project. Currently, the default and only value is v2018-08-01.

users

array of objects

The users (their identifiers, logins, and roles) who will be assigned to the project. You can assign only existing Voucherify users.

It must be used either in the following combinations:

id and role, or
login and role.

users

Responses

Response body

object

string

required

Unique identifier of the project.

name

string

required

The name of the project.

description

string

required

A user-defined description of the project, e.g. its purpose, scope, region.

timezone

string

required

The time zone in which the project is established. It can be in the GMT format or in accordance with IANA time zone database.

currency

string

required

The currency used in the project. It is equal to a 3-letter ISO 4217 code.

dial_code

string | null

The country dial code for the project. It is equal to an ITU country code.

webhook_version

string

required

Defaults to v2024-01-01

The webhook version used in the project.

v2024-01-01

client_trusted_domains

array of strings

required

An array of URL addresses that allow client requests.

client_trusted_domains*

client_redeem_enabled

boolean

required

Enables client-side redemption.

client_publish_enabled

boolean

required

Enables client-side publication.

client_list_vouchers_enabled

boolean

required

Enables client-side listing of vouchers.

client_create_customer_enabled

boolean

required

Enables client-side creation of customers.

client_loyalty_events_enabled

boolean

required

Enables client-side events for loyalty and referral programs.

client_set_voucher_expiration_date_enabled

boolean

required

Enables client-side setting of voucher expiration date.

webhooks_callout_notifications

object

required

Determines the notification settings for webhook callouts configured in Distributions and Project settings.

distributions

object

required

Determines the notification settings for webhooks sent through Distributions.

webhooks

object

required

Determines the notification settings for webhooks sent as set out in the Project settings.

api_usage_notifications

object

required

Determines the notification settings.

redemptions

object

required

Determines the notification settings for redemptions. The notification can be used as a warning that a limit will be reached soon.

messages

object

required

Determines the notification settings for distributed messages according to the day and month limit. The notification can be used as a warning that a limit will be reached soon.

api_calls

object

required

Determines the notification settings for API calls made for the hourly limit. The notification can be used as a warning that a limit will be reached soon. It is sent maximum once per hour.

bulk_api_calls

object

required

Determines the notification settings for bulk API calls made for the hourly limit. The notification can be used as a warning that a limit will be reached soon. It is sent maximum once per hour.

webhook_calls

object

required

Determines the notification settings for webhook calls made for the daily limit. The notification can be used as a warning that a limit will be reached soon. It is sent maximum four times a day.

cycle_calls

object

required

Determines the notification settings for API calls made for the billing cycle limit. The notification can be used as a warning that a limit will be reached soon. It is sent maximum once per the billing cycle.

cluster_id

string

required

The identifier of the cluster where the project will be created.

case_sensitive_codes

boolean

required

Determines if the vouchers in the project will be:

case sensitive - if true, C0dE-cfV is not equal to c0de-cfv),
case insensitive - if false, C0dE-cfV is equal to c0de-cfv.

api_version

string

required

Defaults to v2018-08-01

The API version used in the project. Currently, the default and only value is v2018-08-01.

v2018-08-01

is_sandbox

boolean

required

Determines if the project is a sandbox project.

webhook_token

string

required

Webhook token used for authentication.

server_side_key

object

Contains the app_id and app_token to authenticate server-side requests.

app_id

string

Application ID to be used as X-App-Id header in every HTTP request.

app_token

string

Application token to be used as X-App-Token header in every HTTP request.

The application token (secret key) for the server-side authentication is visible in the Project Settings for 14 days when it is first generated in a newly-created project. Write your application token down and keep it in a safe place.

client_side_key

object

Contains the app_id and app_token to authenticate client-side requests.

app_id

string

Application ID to be used as X-App-Id header in every HTTP request.

app_token

string

Application token to be used as X-App-Token header in every HTTP request.

The application token (secret key) for the client-side authentication is visible in the Project Settings for 14 days when it is first generated in a newly-created project. Write your application token down and keep it in a safe place.

Language

Credentials

URL


xxxxxxxxxx
44
1
curl --request POST \
2
     --url https://api.voucherify.io/management/v1/projects \
3
     --header 'X-Voucherify-Channel: Voucherify Documentation' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
  "case_sensitive_codes": true,
9
  "webhook_version": "v2024-01-01",
10
  "webhooks_callout_notifications": {
11
    "distributions": {
12
      "email": true,
13
      "in_app": true
14
    },
15
    "webhooks": {
16
      "email": true,
17
      "in_app": true
18
    }
19
  },
20
  "api_usage_notifications": {
21
    "messages": {
22
      "enabled": true,
23
      "in_app": true
24
    },
25
    "api_calls": {
26
      "enabled": true,
27
      "in_app": true
28
    },
29
    "bulk_api_calls": {

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the details of a created project.

400Returns an error if the payload is missing required properties in the request.

401Returns an error if an invalid token was provided.

402Returns an error if the current plan does not include the Management API feature.

403Returns an error if the project is to be created in a cluster that is unavailable to the user.