Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.99 KB

ManagementProjectsCreateRequestBody.md

File metadata and controls

48 lines (32 loc) · 2.99 KB

ManagementProjectsCreateRequestBody

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

Properties

Name Type Description
caseSensitiveCodes Boolean 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 The name of the project.
description String A user-defined description of the project, e.g. its purpose, scope, region.
timezone String 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 The currency used in the project. It is equal to a 3-letter ISO 4217 code.
dialCode String The country dial code for the project. It is equal to an ITU country code.
webhookVersion WebhookVersionEnum The webhook version used in the project.
clientTrustedDomains List<String> An array of URL addresses that allow client requests.
clientRedeemEnabled Boolean Enables client-side redemption.
clientPublishEnabled Boolean Enables client-side publication.
clientListVouchersEnabled Boolean Enables client-side listing of vouchers.
clientCreateCustomerEnabled Boolean Enables client-side creation of customers.
clientLoyaltyEventsEnabled Boolean Enables client-side events for loyalty and referral programs.
clientSetVoucherExpirationDateEnabled Boolean Enables client-side setting of voucher expiration date.
webhooksCalloutNotifications ManagementProjectsCreateRequestBodyWebhooksCalloutNotifications
apiUsageNotifications ManagementProjectsCreateRequestBodyApiUsageNotifications
clusterId String The identifier of the cluster where the project will be created. The default cluster is `eu1` unless otherwise configured.
apiVersion ApiVersionEnum The API version used in the project. Currently, the default and only value is `v2018-08-01`.
users List<ManagementProjectsCreateRequestBodyUsersItem> 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`.

Enum: WebhookVersionEnum

Name Value
V2024_01_01 "v2024-01-01"

Enum: ApiVersionEnum

Name Value
V2018_08_01 "v2018-08-01"