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
case_sensitive_codes
boolean
required
name
string
required
timezone
string
required
currency
string
required
description
string
dial_code
string | null
webhook_version
enum<string>
default:v2024-01-01
Available options:
v2024-01-01
client_trusted_domains
string[]
client_redeem_enabled
boolean
client_publish_enabled
boolean
client_list_vouchers_enabled
boolean
client_create_customer_enabled
boolean
client_loyalty_events_enabled
boolean
client_set_voucher_expiration_date_enabled
boolean
webhooks_callout_notifications
object
api_usage_notifications
object
cluster_id
string
api_version
enum<string>
default:v2018-08-01
Available options:
v2018-08-01
users
Create Project Users · object[]

Response

id
string
required
name
string
required
description
string
required
timezone
string
required
currency
string
required
webhook_version
enum<string>
default:v2024-01-01
required
Available options:
v2024-01-01
client_trusted_domains
string[]
required
client_redeem_enabled
boolean
required
client_publish_enabled
boolean
required
client_list_vouchers_enabled
boolean
required
client_create_customer_enabled
boolean
required
client_loyalty_events_enabled
boolean
required
client_set_voucher_expiration_date_enabled
boolean
required
webhooks_callout_notifications
object
required
api_usage_notifications
object
required
cluster_id
string
required
case_sensitive_codes
boolean
required
api_version
enum<string>
default:v2018-08-01
required
Available options:
v2018-08-01
is_sandbox
boolean
required
webhook_token
string
required
server_side_key
object
client_side_key
object
dial_code
string | null