Get Brand

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

{
  "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": null
  },
  "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
  }
}

GET

management

projects

{projectId}

branding

{brandingId}

Get Brand

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

{
  "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": null
  },
  "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
  }
}

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"

brandingId

string

required

Provide the unique identifier of the brand configuration.

Example:

"brd_06d06m1944y0630hD4y"

Response

Returns the brand configuration.

Response body schema for GET /management/v1/projects/{projectId}/branding/{brandingId}. Response brand schema.

string

required

Unique identifier of the brand configuration.

brand

Brand · object

required

Defines basic brand details.

Show child attributes

brand.name

string

required

Defines brand name.

brand.privacy_policy_url

string | null

required

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

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.

brand.permission_reminder

string

required

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

brand.website_url

string | null

required

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

address

Address · object

required

Defines the address details.

Show child attributes

address.street

string

required

Defines the brand's street.

address.city

string

required

Defines the brand's city.

address.postal

string | null

required

Defines the brand's postal code.

address.state

string

required

Defines the brand's state or similar administrative area.

address.country

string

required

Defines the brand's country.

contact

Contact · object

required

Defines contact details.

Show child attributes

contact.email

string

required

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

contact.phone

string | null

required

Defines the brand's phone number.

cockpits

Cockpit · object

required

Defines customer cockpit details.

Show child attributes

cockpits.campaigns_overview_enabled

boolean

required

Enables the campaign overview for customers.

cockpits.loyalty_enabled

boolean

required

Enables the loyalty campaign overview for customers.

cockpits.gift_cards_enabled

boolean

required

Enables the gift card overview for customers.

cockpits.coupons_enabled

boolean

required

Enables the discount coupon overview for customers.

cockpits.referrals_enabled

boolean

required

Enables the referral campaign overview for customers.

cockpits.theme

enum<string>

required

Determines the color scheme of the customer cockpit.

Available options:

blue,

dark-green,

default,

green,

grey,

orange,

purple,

red

cockpits.use_custom_double_opt_in_redirect_url

boolean

required

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

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.

List Brands Update Brand

⌘I

Introduction

Endpoints

Events

Get Brand

Authorizations

Path Parameters

Response