Skip to main content
POST
/
management
/
v1
/
projects
Create Project
curl --request POST \
  --url https://{cluster}.voucherify.io/management/v1/projects \
  --header 'Content-Type: application/json' \
  --header 'X-Management-Id: <api-key>' \
  --header 'X-Management-Token: <api-key>' \
  --data '{
  "case_sensitive_codes": true,
  "name": "<string>",
  "description": "<string>",
  "timezone": "<string>",
  "currency": "<string>",
  "dial_code": "<string>",
  "webhook_version": "v2024-01-01",
  "client_trusted_domains": [
    "<string>"
  ],
  "client_redeem_enabled": true,
  "client_publish_enabled": true,
  "client_list_vouchers_enabled": true,
  "client_create_customer_enabled": true,
  "client_loyalty_events_enabled": true,
  "client_set_voucher_expiration_date_enabled": true,
  "webhooks_callout_notifications": {
    "distributions": {
      "email": true,
      "in_app": true,
      "emails": [
        "<string>"
      ]
    },
    "webhooks": {
      "email": true,
      "in_app": true,
      "emails": [
        "<string>"
      ]
    }
  },
  "api_usage_notifications": {
    "messages": {
      "enabled": true,
      "value": 50,
      "in_app": true,
      "emails": [
        "<string>"
      ]
    },
    "api_calls": {
      "enabled": true,
      "value": 50,
      "in_app": true,
      "emails": [
        "<string>"
      ]
    },
    "bulk_api_calls": {
      "enabled": true,
      "value": 50,
      "in_app": true,
      "emails": [
        "<string>"
      ]
    },
    "webhook_calls": {
      "enabled": true,
      "value": 50,
      "in_app": true,
      "emails": [
        "<string>"
      ]
    },
    "cycle_calls": {
      "enabled": true,
      "value": 50,
      "in_app": true,
      "emails": [
        "<string>"
      ]
    }
  },
  "cluster_id": "<string>",
  "api_version": "v2018-08-01",
  "users": [
    {
      "id": "<string>",
      "login": "<string>",
      "role": "<string>"
    }
  ]
}'
{
  "id": "proj_V0uCh3RiFy",
  "name": "Voucherify Team Project",
  "currency": "EUR",
  "timezone": "UTC",
  "cluster_id": "eu1",
  "api_version": "v2018-08-01",
  "case_sensitive_codes": true,
  "client_trusted_domains": [],
  "client_redeem_enabled": false,
  "client_publish_enabled": false,
  "client_list_vouchers_enabled": false,
  "client_create_customer_enabled": false,
  "client_loyalty_events_enabled": false,
  "client_set_voucher_expiration_date_enabled": false,
  "api_usage_notifications": {
    "messages": {
      "value": 80,
      "emails": [
        "your.email@your.domain"
      ],
      "in_app": true,
      "enabled": true
    },
    "api_calls": {
      "value": 80,
      "emails": [
        "your.email@your.domain"
      ],
      "in_app": true,
      "enabled": true
    },
    "cycle_calls": {
      "value": 80,
      "emails": [
        "your.email@your.domain"
      ],
      "in_app": true,
      "enabled": true
    },
    "redemptions": {
      "value": 80,
      "emails": [],
      "in_app": false,
      "enabled": false
    },
    "webhook_calls": {
      "value": 80,
      "emails": [
        "your.email@your.domain"
      ],
      "in_app": true,
      "enabled": true
    },
    "bulk_api_calls": {
      "value": 80,
      "emails": [
        "your.email@your.domain"
      ],
      "in_app": true,
      "enabled": true
    }
  },
  "webhooks_callout_notifications": {
    "webhooks": {
      "email": true,
      "emails": [
        "your.email@your.domain"
      ],
      "in_app": true
    },
    "distributions": {
      "email": true,
      "emails": [
        "your.email@your.domain"
      ],
      "in_app": true
    }
  },
  "is_sandbox": false,
  "webhook_version": "v2024-01-01"
}

Authorizations

​
X-Management-Id
string
header
required
​
X-Management-Token
string
header
required

Body

application/json

Define project details.

Request body schema for POST /management/v1/projects.

​
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.

​
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.

​
description
string

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

​
dial_code
string | null

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

​
webhook_version
enum<string>
default:v2024-01-01

The webhook version used in the project.

Available options:
v2024-01-01
​
client_trusted_domains
string[]

An array of URL addresses that allow client requests.

​
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
enum<string>
default:v2018-08-01

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

Available options:
v2018-08-01
​
users
Create Project Users · object[]

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.

Response

Returns the details of a created project.

Response body schema for POST management/v1/projects. Object representing a project. Returns app_id and app_token for the server-side and client-side authentication.

​
id
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.

​
webhook_version
enum<string>
default:v2024-01-01
required

The webhook version used in the project.

Available options:
v2024-01-01
​
client_trusted_domains
string[]
required

An array of URL addresses that allow client requests.

​
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.

​
api_usage_notifications
object
required

Determines the notification settings.

​
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
enum<string>
default:v2018-08-01
required

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

Available options:
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.

​
client_side_key
object

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

​
dial_code
string | null

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

⌘I