List Brands

curl --request GET \
  --url https://{cluster}.voucherify.io/management/v1/projects/{projectId}/branding \
  --header 'X-Management-Id: <api-key>' \
  --header 'X-Management-Token: <api-key>'

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "brd_0E603421F0a2fL1814",
      "brand": {
        "name": "Voucherify PSA",
        "privacy_policy_url": null,
        "terms_of_use_url": null,
        "permission_reminder": "You are receiving this email because you opted in at our website.",
        "website_url": "voucherify.io"
      },
      "address": {
        "street": "Porcelanowa 23",
        "city": "Katowice",
        "postal": "40-246",
        "state": null,
        "country": "Poland"
      },
      "contact": {
        "email": "support@voucherify.io",
        "phone": null
      },
      "cockpits": {
        "campaigns_overview_enabled": false,
        "loyalty_enabled": true,
        "gift_cards_enabled": true,
        "coupons_enabled": true,
        "referrals_enabled": true,
        "theme": "default",
        "use_custom_double_opt_in_redirect_url": false,
        "custom_double_opt_in_redirect_url": null
      }
    }
  ],
  "total": 1
}

GET

management

projects

{projectId}

branding

List Brands

curl --request GET \
  --url https://{cluster}.voucherify.io/management/v1/projects/{projectId}/branding \
  --header 'X-Management-Id: <api-key>' \
  --header 'X-Management-Token: <api-key>'

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "brd_0E603421F0a2fL1814",
      "brand": {
        "name": "Voucherify PSA",
        "privacy_policy_url": null,
        "terms_of_use_url": null,
        "permission_reminder": "You are receiving this email because you opted in at our website.",
        "website_url": "voucherify.io"
      },
      "address": {
        "street": "Porcelanowa 23",
        "city": "Katowice",
        "postal": "40-246",
        "state": null,
        "country": "Poland"
      },
      "contact": {
        "email": "support@voucherify.io",
        "phone": null
      },
      "cockpits": {
        "campaigns_overview_enabled": false,
        "loyalty_enabled": true,
        "gift_cards_enabled": true,
        "coupons_enabled": true,
        "referrals_enabled": true,
        "theme": "default",
        "use_custom_double_opt_in_redirect_url": false,
        "custom_double_opt_in_redirect_url": null
      }
    }
  ],
  "total": 1
}

Authorizations

X-Management-Id

string

header

required

X-Management-Token

string

header

required

Path Parameters

projectId

string

required

Provide the unique identifier of the project.

Example:

"proj_TrlkLiH4"

Response

Returns the details about the brand created in the project.

Object containing a list of brand configurations. It always contains one item.

object

enum<string>

default:list

required

The type of the object represented by JSON. This object stores information about the brand in a dictionary.

Available options:

list

data_ref

enum<string>

default:data

required

Identifies the name of the attribute that contains the array of brand objects.

Available options:

data

data

Brand Response · object[]

required

Array of brand objects. It contains only one object.

Show child attributes

data.id

string

required

Unique identifier of the brand configuration.

data.brand

Brand · object

required

Defines basic brand details.

Show child attributes

data.brand.name

string

required

Defines brand name.

data.brand.privacy_policy_url

string | null

required

Defines the URL to the brand's privacy policy. It must be a valid URL format.

data.brand.terms_of_use_url

string | null

required

Defines the URL to the brand's terms of use. It must be a valid URL format.

data.brand.permission_reminder

string

required

Defines the message that is displayed to customers who opted in an email newsletter.

data.brand.website_url

string | null

required

Defines the URL to the brand's website. It must be a valid URL format.

data.address

Address · object

required

Defines the address details.

Show child attributes

data.address.street

string

required

Defines the brand's street.

data.address.city

string

required

Defines the brand's city.

data.address.postal

string | null

required

Defines the brand's postal code.

data.address.state

string

required

Defines the brand's state or similar administrative area.

data.address.country

string

required

Defines the brand's country.

data.contact

Contact · object

required

Defines contact details.

Show child attributes

data.contact.email

string

required

Defines the brand's email address. It must be a valid email format.

data.contact.phone

string | null

required

Defines the brand's phone number.

data.cockpits

Cockpit · object

required

Defines customer cockpit details.

Show child attributes

data.cockpits.campaigns_overview_enabled

boolean

required

Enables the campaign overview for customers.

data.cockpits.loyalty_enabled

boolean

required

Enables the loyalty campaign overview for customers.

data.cockpits.gift_cards_enabled

boolean

required

Enables the gift card overview for customers.

data.cockpits.coupons_enabled

boolean

required

Enables the discount coupon overview for customers.

data.cockpits.referrals_enabled

boolean

required

Enables the referral campaign overview for customers.

data.cockpits.theme

enum<string>

required

Determines the color scheme of the customer cockpit.

Available options:

blue,

dark-green,

default,

green,

grey,

orange,

purple,

red

data.cockpits.use_custom_double_opt_in_redirect_url

boolean

required

Enables the double opt-in option. It must be a valid URL format.

data.cockpits.custom_double_opt_in_redirect_url

string | null

required

Defines the URL for the double opt-in consent. It must be a valid URL format.

total

integer

required

The total number of brand objects. It is always 1.

Create Brand Get Brand

⌘I

Introduction

Endpoints

Events

List Brands

Authorizations

Path Parameters

Response