> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Brand

> Updates a brand configuration.

Only the fields sent in the request will be updated. The fields omitted in the request will remain unchanged.

> 📘 White Labelling
>
> The white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface.



## OpenAPI

````yaml /openapi/management.json put /management/v1/projects/{projectId}/branding/{brandingId}
openapi: 3.0.1
info:
  title: Voucherify API - Management
  version: v2018-08-01
  description: >-
    Voucherify promotion engine REST API. Please see
    https://docs.voucherify.io/docs for more details.
  contact:
    name: Voucherify Team
    url: https://www.voucherify.io/contact-support
    email: support@voucherify.io
  termsOfService: https://www.voucherify.io/legal/subscription-agreement
  license:
    name: MIT
    url: https://github.com/voucherifyio/voucherify-js-sdk/blob/main/LICENSE
servers:
  - url: https://{cluster}.voucherify.io
    description: Base URL
    variables:
      cluster:
        default: api
        enum:
          - api
          - us1.api
          - as1.api
          - download
          - us1.download
          - as1.download
security: []
paths:
  /management/v1/projects/{projectId}/branding/{brandingId}:
    parameters:
      - schema:
          $ref: '#/components/schemas/ParameterProjectId'
        in: path
        name: projectId
        description: Provide the unique identifier of the project.
        required: true
      - schema:
          $ref: '#/components/schemas/ParameterBrandingId'
        in: path
        name: brandingId
        description: Provide the unique identifier of the brand configuration.
        required: true
    put:
      tags:
        - Management
      summary: Update Brand
      description: >-
        Updates a brand configuration.


        Only the fields sent in the request will be updated. The fields omitted
        in the request will remain unchanged.


        > 📘 White Labelling

        >

        > The white labelling settings which can be found in Project Settings >
        Brand Details and which are available only for Enterprise clients as a
        separate service can be configured only in the user interface.
      operationId: update-brand
      parameters: []
      requestBody:
        description: Defines the brand configuration to be updated.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagementProjectsBrandingUpdateRequestBody'
        required: true
      responses:
        '200':
          description: Returns the details about the updated brand configuration.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ManagementProjectsBrandingUpdateResponseBody
              examples:
                Example:
                  value:
                    id: brd_0ead90c940a9deef09
                    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: 43-246
                      state: null
                      country: Poland
                    contact:
                      email: your_email@your-domain.com
                      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
        '400':
          description: Returns an error if the payload includes incorrect details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e_400_invalid_payload'
              examples:
                Invalid payload:
                  value:
                    code: 400
                    key: invalid_payload
                    message: Invalid payload
                    details: Property .properties.Size.eq.0 must be number
                    request_id: v-0ea5a9b9b3402940a9
        '401':
          description: Returns an error if an invalid token was provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Unauthorized:
                  value:
                    code: 401
                    message: Unauthorized
                    key: unauthorized
        '402':
          description: >-
            Returns an error if the current plan does not include the Management
            API feature.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorPaymentRequired'
              examples:
                Example:
                  value:
                    code: 402
                    message: Payment required
                    details: >-
                      Your current plan does not include a feature required to
                      perform this operation.
                    key: missing_required_feature
        '404':
          description: Returns an error when a resource could not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Not Found:
                  value:
                    code: 404
                    key: not_found
                    message: Resource not found
                    details: Cannot find branding_details with id brd_0e603885e0c5fc180
                    request_id: v-0ead68aa7c56588378
                    resource_id: brd_0e603885e0c5fc180
                    resource_type: branding_details
      security:
        - X-Management-Id: []
          X-Management-Token: []
components:
  schemas:
    ParameterProjectId:
      type: string
      example: proj_TrlkLiH4
    ParameterBrandingId:
      type: string
      example: brd_06d06m1944y0630hD4y
    ManagementProjectsBrandingUpdateRequestBody:
      type: object
      title: Brand
      properties:
        brand:
          type: object
          title: Brand
          description: Defines basic brand details.
          properties:
            name:
              type: string
              description: Defines brand name.
            privacy_policy_url:
              type: string
              nullable: true
              description: Defines the URL to the brand's privacy policy.
            terms_of_use_url:
              type: string
              nullable: true
              description: Defines the URL to the brand's terms of use.
            permission_reminder:
              type: string
              description: >-
                Defines the message that is displayed to customers who opted in
                an email newsletter.
            website_url:
              type: string
              nullable: true
              description: Defines the URL to the brand's website.
        address:
          type: object
          title: Address
          description: Defines the address details.
          properties:
            street:
              type: string
              description: Defines the brand's street.
            city:
              type: string
              description: Defines the brand's city.
            postal:
              type: string
              nullable: true
              description: Defines the brand's postal code
            state:
              type: string
              description: Defines the brand's state or similar administrative area.
            country:
              type: string
              description: Defines the brand's country.
        contact:
          type: object
          title: Contact
          description: Defines contact details.
          properties:
            email:
              type: string
              description: >-
                Defines the brand's email address. It must be a valid email
                format.
            phone:
              type: string
              nullable: true
              description: Defines the brand's phone number.
        cockpits:
          type: object
          title: Cockpit
          description: Defines customer cockpit details.
          properties:
            campaigns_overview_enabled:
              type: boolean
              description: Indicates if the campaign overview is turned on for customers.
            loyalty_enabled:
              type: boolean
              description: >-
                Indicates if the loyalty campaign overview is turned on for
                customers.
            gift_cards_enabled:
              type: boolean
              description: Indicates if the gift card overview is turned on for customers.
            coupons_enabled:
              type: boolean
              description: >-
                Indicates if the discount coupon overview is turned on for
                customers.
            referrals_enabled:
              type: boolean
              description: >-
                Indicates if the referral campaign overview is turned on for
                customers.
            theme:
              type: string
              description: Determines the color scheme of the customer cockpit.
              enum:
                - orange
                - green
                - dark-green
                - blue
                - purple
                - red
                - grey
            use_custom_double_opt_in_redirect_url:
              type: boolean
              description: Indicates if the double opt-in option is turned on.
            custom_double_opt_in_redirect_url:
              type: string
              nullable: true
              description: Defines the URL for the double opt-in consent.
    ManagementProjectsBrandingUpdateResponseBody:
      type: object
      title: Management Projects Branding Update Response Body
      description: >-
        Response body schema for **PUT**
        `/management/v1/projects/{projectId}/branding/{brandingId}`.
      allOf:
        - $ref: '#/components/schemas/ManagementProjectsBranding'
    e_400_invalid_payload:
      title: Invalid Payload
      type: object
      description: 'Error: Bad Request → Invalid Payload'
      properties:
        code:
          type: integer
          default: 400
          description: Error's HTTP status code.
        key:
          type: string
          default: invalid_payload
          description: Short string describing the kind of error which occurred.
        message:
          type: string
          default: Invalid payload
          description: A human-readable message providing a short description of the error.
        details:
          type: string
          description: A human-readable message providing more details about the error.
        request_id:
          type: string
          example: v-0a884c6be8c3756f42
          description: >-
            This ID is useful when troubleshooting and/or finding the root cause
            of an error response by our support team.
    Error:
      title: Error Object
      type: object
      description: Error details
      properties:
        code:
          type: integer
          description: Error's HTTP status code.
        key:
          type: string
          description: Short string describing the kind of error which occurred.
        message:
          type: string
          description: A human-readable message providing a short description of the error.
        details:
          type: string
          description: A human-readable message providing more details about the error.
        request_id:
          type: string
          example: v-0a885062c80375740f
          description: >-
            This ID is useful when troubleshooting and/or finding the root cause
            of an error response by our support team.
        resource_id:
          type: string
          description: >-
            Unique resource ID that can be used in another endpoint to get more
            details.
          example: rf_0c5d710a87c8a31f86
        resource_type:
          type: string
          description: The resource type.
          example: voucher
        error:
          type: object
          description: Includes additional information about the error.
          properties:
            message:
              type: string
              description: The message configured by the user in a validation rule.
      required:
        - code
        - message
    ErrorPaymentRequired:
      title: Payment Required Error
      type: object
      description: 'Error: Payment required - the current plan does not include the feature.'
      properties:
        code:
          type: integer
          description: Error's HTTP status code.
        message:
          type: string
          description: A human-readable message providing a short description of the error.
        details:
          type: string
          description: A human-readable message providing more details about the error.
        key:
          type: string
          description: Short string describing the kind of error which occurred.
      required:
        - code
        - message
        - details
        - key
    ManagementProjectsBranding:
      type: object
      title: Brand Response
      description: Response brand schema.
      properties:
        id:
          type: string
          description: Unique identifier of the brand configuration.
        brand:
          type: object
          title: Brand
          description: Defines basic brand details.
          properties:
            name:
              type: string
              description: Defines brand name.
            privacy_policy_url:
              type: string
              nullable: true
              description: >-
                Defines the URL to the brand's privacy policy. It must be a
                valid URL format.
            terms_of_use_url:
              type: string
              nullable: true
              description: >-
                Defines the URL to the brand's terms of use.  It must be a valid
                URL format.
            permission_reminder:
              type: string
              description: >-
                Defines the message that is displayed to customers who opted in
                an email newsletter.
            website_url:
              type: string
              nullable: true
              description: >-
                Defines the URL to the brand's website. It must be a valid URL
                format.
          required:
            - name
            - privacy_policy_url
            - terms_of_use_url
            - permission_reminder
            - website_url
        address:
          type: object
          title: Address
          description: Defines the address details.
          properties:
            street:
              type: string
              description: Defines the brand's street.
            city:
              type: string
              description: Defines the brand's city.
            postal:
              type: string
              nullable: true
              description: Defines the brand's postal code.
            state:
              type: string
              description: Defines the brand's state or similar administrative area.
            country:
              type: string
              description: Defines the brand's country.
          required:
            - street
            - city
            - postal
            - state
            - country
        contact:
          type: object
          title: Contact
          description: Defines contact details.
          properties:
            email:
              type: string
              description: >-
                Defines the brand's email address. It must be a valid email
                format.
            phone:
              type: string
              nullable: true
              description: Defines the brand's phone number.
          required:
            - email
            - phone
        cockpits:
          type: object
          title: Cockpit
          description: Defines customer cockpit details.
          properties:
            campaigns_overview_enabled:
              type: boolean
              description: Enables the campaign overview for customers.
            loyalty_enabled:
              type: boolean
              description: Enables the loyalty campaign overview for customers.
            gift_cards_enabled:
              type: boolean
              description: Enables the gift card overview for customers.
            coupons_enabled:
              type: boolean
              description: Enables the discount coupon overview for customers.
            referrals_enabled:
              type: boolean
              description: Enables the referral campaign overview for customers.
            theme:
              type: string
              description: Determines the color scheme of the customer cockpit.
              enum:
                - blue
                - dark-green
                - default
                - green
                - grey
                - orange
                - purple
                - red
            use_custom_double_opt_in_redirect_url:
              type: boolean
              description: Enables the double opt-in option. It must be a valid URL format.
            custom_double_opt_in_redirect_url:
              type: string
              nullable: true
              description: >-
                Defines the URL for the double opt-in consent. It must be a
                valid URL format.
          required:
            - campaigns_overview_enabled
            - loyalty_enabled
            - gift_cards_enabled
            - coupons_enabled
            - referrals_enabled
            - theme
            - use_custom_double_opt_in_redirect_url
            - custom_double_opt_in_redirect_url
      required:
        - id
        - brand
        - address
        - contact
        - cockpits
  securitySchemes:
    X-Management-Id:
      type: apiKey
      name: X-Management-Id
      in: header
    X-Management-Token:
      type: apiKey
      name: X-Management-Token
      in: header

````