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

# Add a custom field to a project

> PUT adds a custom field to one project (DELETE on the same path removes it). Puts a project or task custom field on one project, as adding it in the app's field dialog does: a project's field on the project, a task's field in its task table. An added field is shown in the app, internal for sharing unless the project's settings already share it. A removed one is recorded as removed, even when it was not there, so a value written later through the API does not show it until someone adds it back. A project or template another request is changing is a 409: try again. Adding a field that is there changes nothing. It sets no value: once the field is on the project, its value is written with PATCH /v1/objects/project/records/{project_id} (or the task's update). It replies `on_project: true` once the field is on the project.



## OpenAPI

````yaml /api/statisfy-api.openapi.json put /v1/objects/project/records/{project_id}/fields/{field_key}
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/objects/project/records/{project_id}/fields/{field_key}:
    put:
      tags:
        - projects
      summary: Add a custom field to a project
      description: >-
        PUT adds a custom field to one project (DELETE on the same path removes
        it). Puts a project or task custom field on one project, as adding it in
        the app's field dialog does: a project's field on the project, a task's
        field in its task table. An added field is shown in the app, internal
        for sharing unless the project's settings already share it. A removed
        one is recorded as removed, even when it was not there, so a value
        written later through the API does not show it until someone adds it
        back. A project or template another request is changing is a 409: try
        again. Adding a field that is there changes nothing. It sets no value:
        once the field is on the project, its value is written with PATCH
        /v1/objects/project/records/{project_id} (or the task's update). It
        replies `on_project: true` once the field is on the project.
      operationId: projects_add_field
      parameters:
        - description: >-
            The project's id. To find it from the project's name: make_get_call
            with path `/v1/objects/project/records` and query
            `{"filter[title][eq]": "<name>"}` (the key written exactly so, flat,
            not nested). Call it directly; no need to look the operation up
            first
          in: path
          name: project_id
          required: true
          schema:
            type: string
        - description: >-
            The field's key (such as `arr__c_`), not its label (`Arr`). To find
            it: make_get_call with path `/v1/fields` and query `{"object":
            "project"}` lists each field's key beside its label; use the key
            whose label the person said. Call it directly; no need to look the
            operation up first
          in: path
          name: field_key
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectField'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    ProjectField:
      properties:
        field:
          title: Field
          type: string
        object:
          anyOf:
            - enum:
                - project
                - task
              type: string
            - type: 'null'
          description: >-
            project: the field shows on the project; task: in its task table.
            null only for a remove that found the field on neither, when it is
            attached both to projects and to tasks
          title: Object
        on_project:
          description: Whether the field is on the project after the call
          title: On Project
          type: boolean
        project:
          title: Project
          type: string
      required:
        - project
        - field
        - object
        - on_project
      title: ProjectField
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

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