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

# Create Custom Field

> Register a new custom field on a `(category, model)` pair. The field carries no mapping yet — attach one with the create mapping endpoint.



## OpenAPI

````yaml post /api/v1/custom-fields
openapi: 3.1.0
info:
  title: Bindbee APIs
  version: 0.1.0
servers:
  - url: https://api.bindbee.dev
  - url: https://api-eu.bindbee.dev
security: []
paths:
  /api/v1/custom-fields:
    post:
      tags:
        - Custom Fields
      summary: Create Custom Field
      description: Create a new custom field.
      operationId: create_custom_field_api_v1_custom_fields_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFieldCreateExternal'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Create Custom Field Api V1 Custom Fields Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    CustomFieldCreateExternal:
      properties:
        name:
          type: string
          maxLength: 128
          minLength: 2
          title: Name
          description: Name of the custom field. Must be snake_case.
          examples:
            - guardian_mobile
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Description of the custom field.
          examples:
            - Employee's guardian mobile number
        category:
          $ref: '#/components/schemas/Category'
          description: Category of the model on which the custom field is created.
          examples:
            - HRIS
        model:
          type: string
          maxLength: 64
          pattern: ^[a-z][a-z0-9_-]*$
          title: Model
          description: Model on which the custom field is to be applied.
          examples:
            - employee
      type: object
      required:
        - name
        - category
        - model
      title: CustomFieldCreateExternal
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Category:
      type: string
      enum:
        - HRIS
        - ATS
        - LMS
      title: Category
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````