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

# Update a field

> Partial update: only the keys present in the body change. Answers 204 with no body.



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/fields/{id}
openapi: 3.0.3
info:
  title: Leadstaker API
  version: 1.0.0
  description: Public REST API for Leadstaker projects.
servers:
  - url: https://n-api.leadstaker.com
    description: Production
security: []
tags:
  - name: Fields
    description: >-
      Custom field definitions, both the built-in ones and the ones a project
      creates.
  - name: Field groups
    description: Sections that organize custom fields in the interface.
  - name: Deals
    description: Opportunities moving through a pipeline, each tied to a contact.
  - name: Contacts
    description: >-
      People inside a project, holding the custom field values collected about
      them.
  - name: Messages
    description: Individual messages inside a chat, inbound and outbound.
  - name: Chats
    description: Conversations with a contact over a connected channel.
  - name: Loss reasons
    description: The catalog of reasons a deal can be marked as lost.
  - name: Pipelines
    description: Ordered sets of stages a deal travels through.
  - name: Stages
    description: Steps inside a pipeline, including the built-in open and closed ones.
  - name: Tags
    description: Free-form labels attached to deals.
  - name: Notes
    description: >-
      Free text attached to a contact or a deal, written by a user, an agent, or
      the system.
paths:
  /v1/fields/{id}:
    patch:
      tags:
        - Fields
      summary: Update a field
      description: >-
        Partial update: only the keys present in the body change. Answers 204
        with no body.
      operationId: patchFieldsById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              anyOf:
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - TEXT
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties: {}
                      additionalProperties: false
                      default: {}
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - NUMBER
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties:
                        min:
                          type: number
                        max:
                          type: number
                      additionalProperties: false
                      default: {}
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - DATE
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties: {}
                      additionalProperties: false
                      default: {}
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - BOOLEAN
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties: {}
                      additionalProperties: false
                      default: {}
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - OPTIONS
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties:
                        options:
                          type: array
                          items:
                            type: string
                          minItems: 1
                      required:
                        - options
                      additionalProperties: false
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - MULTISELECT
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties:
                        options:
                          type: array
                          items:
                            type: string
                          minItems: 1
                      required:
                        - options
                      additionalProperties: false
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - PHONE
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties: {}
                      additionalProperties: false
                      default: {}
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - EMAIL
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties: {}
                      additionalProperties: false
                      default: {}
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - CPF
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties:
                        strict:
                          type: boolean
                      additionalProperties: false
                      default: {}
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - CNPJ
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties:
                        strict:
                          type: boolean
                      additionalProperties: false
                      default: {}
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - CPF_CNPJ
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties:
                        strict:
                          type: boolean
                      additionalProperties: false
                      default: {}
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - CEP
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties: {}
                      additionalProperties: false
                      default: {}
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - CURRENCY
                    label:
                      type: string
                      minLength: 1
                    config:
                      type: object
                      properties:
                        currency:
                          type: string
                          enum:
                            - BRL
                        min:
                          type: number
                        max:
                          type: number
                      additionalProperties: false
                      default: {}
                    position:
                      type: integer
                      minimum: 0
                    fieldGroupId:
                      type: string
                      minLength: 1
                    level:
                      type: string
                      enum:
                        - USER
                        - API
                  required:
                    - type
                  additionalProperties: false
      responses:
        '204':
          description: No content
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The payload failed validation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Error:
      type: object
      required:
        - errorCode
        - message
        - status
      properties:
        errorCode:
          type: string
        message:
          type: string
        status:
          type: integer
        errors:
          type: array
          items:
            type: object
            required:
              - field
              - code
              - message
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````