> ## Documentation Index
> Fetch the complete documentation index at: https://help.scribe-mail.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a smart field



## OpenAPI

````yaml /api-reference/openapi.json post /v1/smart_fields
openapi: 3.0.1
info:
  title: Scribe Public API
  version: v1
  description: >-
    REST API to manage email signatures, teammates, smart fields, and marketing
    campaigns in your Scribe workspace. Every request uses JSON and is
    authenticated with a workspace API key. Endpoints are versioned under `/v1`,
    for example `https://api.scribe-mail.com/v1/signatures`.
  contact:
    name: Scribe Support
    url: https://help.scribe-mail.com/en
servers:
  - url: https://api.scribe-mail.com
    description: Production
security: []
tags:
  - name: Signatures
    description: >-
      Create, update, publish, and install email signature templates, and
      control which teammates each signature is assigned to.
  - name: Teammates
    description: >-
      Manage the people whose signatures Scribe deploys, and set their smart
      field values.
  - name: Emails
    description: >-
      Manage teammate email addresses, including the aliases that receive a
      signature.
  - name: Smart fields
    description: >-
      Define the dynamic fields, such as job title, phone number, or calendar
      link, that populate signatures.
  - name: Folders
    description: Organize signature templates into folders.
  - name: Assets
    description: >-
      Upload and manage the images and files used across signatures and
      campaigns.
  - name: Marketing campaigns
    description: >-
      Schedule, pause, and resume the promotional banners shown in your team's
      signatures.
  - name: Integrations
    description: >-
      List the directory, HRIS, and email integrations connected to your
      workspace.
  - name: Integration entities
    description: >-
      List the org units and groups from your connected integrations, used to
      target signatures.
  - name: Financial documents
    description: List the invoices and financial documents for your workspace.
paths:
  /v1/smart_fields:
    post:
      tags:
        - Smart fields
      summary: Create a smart field
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/smart_field_create_params'
      responses:
        '201':
          description: Created and linked to an integration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/smart_field_response'
        '422':
          description: Unknown integration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validation_error_response'
      security:
        - ApiKey: []
components:
  schemas:
    smart_field_create_params:
      type: object
      properties:
        smart_field:
          type: object
          properties:
            label:
              type: string
            kind:
              type: string
              enum:
                - text
                - url
                - email
                - phone_number
                - image
            required:
              type: boolean
            integration_id:
              type: string
              nullable: true
            integration_attribute:
              type: string
              nullable: true
          required:
            - label
          additionalProperties: false
      required:
        - smart_field
      additionalProperties: false
    smart_field_response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/smart_field'
      required:
        - data
      additionalProperties: false
    validation_error_response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
          required:
            - type
            - code
            - message
          additionalProperties: false
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
              allowed:
                type: array
                description: >-
                  For an enum/const violation: the permitted values for this
                  field. Present only when the list is small enough to inline;
                  for large enums (e.g. icon) see the content schema.
                items: {}
              missing:
                type: array
                description: 'For a missing-required violation: the absent property names.'
                items:
                  type: string
            required:
              - field
              - code
              - message
            additionalProperties: false
      required:
        - error
        - details
      additionalProperties: false
    smart_field:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        slug:
          type: string
          nullable: true
        kind:
          type: string
          enum:
            - text
            - url
            - email
            - phone_number
            - image
        required:
          type: boolean
        default:
          type: boolean
        position:
          type: integer
        integration_id:
          type: string
          nullable: true
        integration_attribute:
          type: string
          nullable: true
        used_in_signatures:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - label
        - slug
        - kind
        - required
        - default
        - position
        - integration_id
        - integration_attribute
        - used_in_signatures
        - created_at
        - updated_at
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer

````