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

# Create a brand attribute

> Defines a new custom attribute field for the brand (for example encrypted, searchable, or standard columns).



## OpenAPI

````yaml /openapi/brand-api.json post /{brand_id}/attributes
openapi: 3.0.0
info:
  title: Bambu Brand API
  description: >-
    Partner APIs for issuing and managing wallet cards, activations,
    transactions, SMS, and program configuration. Start with the Guides tab for
    authentication and your first issue-wallet call.
  version: 1.0.0
servers:
  - url: https://api.bambumeta.software/brands
    description: Production
  - url: https://api-sandbox.bambumeta.software/brands
    description: Sandbox
security: []
tags:
  - name: brand
    description: Brand setup and configuration
  - name: brand-activation
    description: Onboarding activations and issue-wallet for an activation
  - name: brands
    description: Custom brand attribute fields
  - name: link-activation
    description: Distribution link activation CRUD
  - name: onboarding
    description: >-
      Program onboarding metrics (internal tag, grouped under reporting in the
      portal)
  - name: program
    description: Program setup and transactions
  - name: reporting
    description: Pass and stage breakdown reports
  - name: sms
    description: Send outbound SMS messages
  - name: subscription
    description: SMS subscription enrollment and stage updates
  - name: template
    description: Wallet template management
  - name: transactions
    description: Transaction types, records, and program transactions
  - name: wallet
    description: Issue, retrieve, update, and delete wallet cards
  - name: wallet-bulk
    description: Bulk pass updates and scheduled changes
  - name: workflow
    description: Trigger workflows that issue or update passes
paths:
  /{brand_id}/attributes:
    post:
      tags:
        - brands
        - onboarding
      summary: Create a brand attribute
      description: >-
        Defines a new custom attribute field for the brand (for example
        encrypted, searchable, or standard columns).
      parameters:
        - name: brand_id
          in: path
          description: Brand Identifier
          required: true
          style: simple
          explode: false
          schema:
            type: number
          example: '353'
      requestBody:
        description: The brand attribute creation input
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BrandAttributeInput'
            example:
              name: memberId
              dataType: string
              searchable: true
              unique: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandAttribute'
              example:
                brandAttributeId: 8
                name: memberId
                dataType: string
                searchable: true
                unique: true
      security:
        - cognito-authorizer:
            - https://admin.bambumeta.software/ui
components:
  schemas:
    BrandAttributeInput:
      type: object
      properties:
        name:
          type: string
          description: Attribute name
        description:
          type: string
          description: Description of the Attribute
        brandId:
          type: number
          description: Unique identifier for the brand
        required:
          type: boolean
          description: Is the attribute required
        encrypted:
          type: boolean
          description: Is the attribute encrypted
        searchable:
          type: boolean
          description: Is the attribute searchable
        unique:
          type: boolean
          description: Is the attribute unique
        statusCode:
          type: number
          description: Status code for the brand attribute
        dataType:
          type: string
          description: >-
            Valid values: 'string'|'number'|'boolean'|'date', in not provided,
            assumes string.
        providedOpttions:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: Display Name for the option
              value:
                type: string
                description: A string or number value associated to the option.
              isDefault:
                type: boolean
                description: Is the default option
    BrandAttribute:
      type: object
      properties:
        BrandAttributeId:
          type: number
          description: Unique identifier for the brand attribute
        name:
          type: string
          description: Attribute name
        description:
          type: string
          description: Description of the Attribute
        brandId:
          type: number
          description: Unique identifier for the brand
        required:
          type: boolean
          description: Is the attribute required
        encrypted:
          type: boolean
          description: Is the attribute encrypted
        searchable:
          type: boolean
          description: Is the attribute searchable
        unique:
          type: boolean
          description: Is the attribute unique
        statusCode:
          type: number
          description: Status code for the brand attribute
        dataType:
          type: string
          description: >-
            Valid values: 'string'|'number'|'boolean'|'date', in not provided,
            assumes string.
        providedOptions:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: Display Name for the option
              value:
                type: string
                description: A string or number value associated to the option.
              isDefault:
                type: boolean
                description: Is the default option
  securitySchemes:
    cognito-authorizer:
      type: apiKey
      name: Authorization
      in: header

````