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

# Create a customer field

> Adds a field of your project's own. With extract on, conversations fill it from what customers say, guided by its description.



## OpenAPI

````yaml /api-reference/openapi.documented.json post /v1/customer/fields
openapi: 3.1.0
info:
  title: Roark Analytics API
  description: >-
    The Roark Analytics API gives you access to the same API that powers the
    award winning Roark Analytics platform.
  version: 1.0.0
servers:
  - description: Production
    url: https://api.roark.ai
security:
  - Bearer: []
tags:
  - name: Agent
  - name: Customer
  - name: Agent Endpoint
  - name: Tool
  - name: Phone Number
  - name: Call
  - name: Chat
  - name: Metric
  - name: Metric Policy
  - name: Metric Collection Job
  - name: Customer Flow
  - name: Customer Flow Edge Case
  - name: Simulation
  - name: Simulation Persona
  - name: Simulation Environment
  - name: Simulation Scenario
  - name: Simulation Run Plan
  - name: Simulation Template
  - name: Simulation Audio Clip
  - name: Simulation Run Plan Job
  - name: Simulation Job
  - name: HTTP Request Definition
  - name: Webhook
  - name: Issue
  - name: Autoimprove
  - name: Agent Config
  - name: Knowledge Base
  - name: Calendar Connection
  - name: Config
  - name: Organization Project
  - name: Organization Project Member
  - name: Organization Project API Key
  - name: Organization Config
  - name: CLI Auth
  - name: Me
  - name: Project
  - name: Usage
  - name: Analytics
  - name: Dashboard
  - name: Live Report
  - name: Benchmark
  - name: Health
  - name: Prospect Simulation
  - name: Campaign Credit
paths:
  /v1/customer/fields:
    post:
      tags:
        - Customer
      summary: Create a customer field
      description: >-
        Adds a field of your project's own. With extract on, conversations fill
        it from what customers say, guided by its description.
      operationId: postV1CustomerFields
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                key:
                  type: string
                  pattern: ^[A-Za-z][A-Za-z0-9_]{0,99}$
                  description: >-
                    Starts with a letter; letters, numbers and underscores only.
                    Fixed once created.
                  example: plan_tier
                label:
                  type: string
                  minLength: 1
                  maxLength: 100
                description:
                  type:
                    - string
                    - 'null'
                  minLength: 1
                  maxLength: 500
                  description: >-
                    What the agent listens for in a conversation. Required when
                    extract is true.
                valueType:
                  type: string
                  enum:
                    - TEXT
                    - NUMBER
                    - BOOLEAN
                    - DATE
                    - PHONE_NUMBER
                    - EMAIL
                    - CURRENCY
                extract:
                  type: boolean
                  description: Whether conversations fill this field
              required:
                - key
                - label
                - valueType
                - extract
      responses:
        '201':
          description: Created field
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      key:
                        type: string
                        description: >-
                          What filters, sorts and attribute routes name the
                          field by
                      label:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                        description: What extraction looks for in a conversation
                      valueType:
                        type: string
                        enum:
                          - TEXT
                          - NUMBER
                          - BOOLEAN
                          - DATE
                          - PHONE_NUMBER
                          - EMAIL
                          - CURRENCY
                      source:
                        type: string
                        enum:
                          - SYSTEM
                          - CUSTOM
                        description: >-
                          SYSTEM for a built-in field, CUSTOM for one your
                          project defined
                      extract:
                        type: boolean
                        description: >-
                          Whether conversations fill this field on this project:
                          the project's own setting where it made one
                      redactedBy:
                        type:
                          - string
                          - 'null'
                        enum:
                          - redactName
                          - redactEmail
                          - redactPhone
                          - redactDateOfBirth
                          - redactAddress
                          - redactBankAccountNumber
                        description: >-
                          The project redaction setting that, when on, keeps
                          conversations from filling this field
                    required:
                      - key
                      - label
                      - description
                      - valueType
                      - source
                      - extract
                      - redactedBy
                required:
                  - data
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Validation error
              example:
                type: validation
                code: invalid_parameter
                message: The request was invalid
                param: email
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Conflict error
              example:
                type: conflict
                code: resource_in_use
                message: The resource is in use and cannot be deleted
          description: Conflict
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Roark from '@roarkanalytics/sdk';

            const client = new Roark({
              bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
            });

            const response = await client.customer.createField({
              extract: true,
              key: 'plan_tier',
              label: 'x',
              valueType: 'TEXT',
            });

            console.log(response.data);
        - lang: Python
          source: |-
            import os
            from roark_analytics import Roark

            client = Roark(
                bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
            )
            response = client.customer.create_field(
                extract=True,
                key="plan_tier",
                label="x",
                value_type="TEXT",
            )
            print(response.data)
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation
            - authentication
            - forbidden
            - not_found
            - conflict
            - payment_required
            - rate_limit
            - internal
          description: The error type category
          examples:
            - validation
            - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
            - invalid_parameter
            - missing_required_field
            - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
            - The request was invalid
            - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
            - email
            - user_id
        details:
          description: Additional error context information
      required:
        - type
        - code
        - message
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.