> ## Documentation Index > Fetch the complete documentation index at: https://docs.tented.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update a custom field > Update a custom field's display name, description, editability, default list visibility, or status. At least one property must be provided. - **Archive / restore:** set `status: "archived"` to archive a field (its values are retained but it stops appearing in default field lists), or `status: "active"` to restore it. - **System fields are read-only** — passing a standard field name (e.g. `email`) instead of a custom field's UUID returns `400` (`System fields are read-only`). The `api_name` and `value_type` of a custom field cannot be changed. - **Integration-managed fields** reject `display_name`, `description`, and `status` edits (`400`); only `is_editable` and `show_in_people_list_default` can be changed. ## OpenAPI ````yaml /api-reference/openapi.json patch /v1/contact-fields/{fieldDefinitionId} openapi: 3.1.0 info: title: Tented API version: 1.0.0 description: >- The Tented public API: generate, publish, and manage AI-built web pages (tents), and run the email platform — contacts, reusable emails, one-time blasts, and triggered flows. ## Authentication Authenticate every request with a workspace API key: `Authorization: Bearer `. Keys are created in **Workspace Settings → API Keys** and are scoped to a single workspace. ## Asynchronous work Tent generation, bulk creation, and email AI generation return `202 Accepted` immediately. Poll the corresponding status endpoint (`GET /v1/tents/{tentId}`, `GET /v1/bulk-jobs/{bulkJobId}`, `GET /v1/emails/{emailId}/generations/{generationId}`) — no more than every 10 seconds. ## Pagination Email listings use cursor pagination (`cursor`/`next_cursor`). Blast, flow, and member listings use page pagination (`page`/`limit` with a `pagination` object in the response). ## Conventions Request and response fields are snake_case, with two exceptions: analytics query parameters (`tentIdOrAlias`, `daysBack`) and segment rule trees (camelCase keys such as `listId` and `timeWindow`). contact: name: Tented Support email: support@tented.ai servers: - url: https://api.tented.ai description: Production security: - bearerAuth: [] tags: - name: Tents description: >- Create, edit, publish, and manage AI-generated pages, including asset uploads and bulk creation. - name: Analytics description: Traffic analytics for single tents and the whole workspace. - name: Contacts description: >- Batch create, update, and delete contacts. Up to 25 items per request with per-item results. - name: Emails description: >- Reusable email content: AI generation, direct HTML edits, plain-text control, and approval. - name: Email Blasts description: >- One-time sends to an audience: compose, schedule, track engagement, export recipients. - name: Triggered Flows description: >- Multi-step automations that enroll contacts on triggers and move them through a step graph. - name: Contact Imports - name: Contact Fields - name: Contact Lists - name: Email Templates - name: Tent Templates description: >- Reusable, AI-editable tent layouts. Create from HTML or an existing tent, iterate with AI, approve, and clone. Approved tent templates seed new tents. paths: /v1/contact-fields/{fieldDefinitionId}: patch: tags: - Contact Fields summary: Update a custom field description: >- Update a custom field's display name, description, editability, default list visibility, or status. At least one property must be provided. - **Archive / restore:** set `status: "archived"` to archive a field (its values are retained but it stops appearing in default field lists), or `status: "active"` to restore it. - **System fields are read-only** — passing a standard field name (e.g. `email`) instead of a custom field's UUID returns `400` (`System fields are read-only`). The `api_name` and `value_type` of a custom field cannot be changed. - **Integration-managed fields** reject `display_name`, `description`, and `status` edits (`400`); only `is_editable` and `show_in_people_list_default` can be changed. operationId: update-contact-field parameters: - name: fieldDefinitionId in: path required: true schema: type: string format: uuid description: >- Custom field definition ID (`field_definition_id` from the list or create response). requestBody: required: true content: application/json: schema: type: object properties: display_name: type: string minLength: 1 maxLength: 255 description: New human-readable label. description: type: - string - 'null' maxLength: 1000 description: New description, or `null` to clear it. is_editable: type: boolean description: Whether values can be edited manually in the UI. show_in_people_list_default: type: boolean description: >- Whether the field appears as a column in the People list by default. status: type: string enum: - active - archived description: Set `archived` to archive the field, `active` to restore it. minProperties: 1 description: At least one property is required. responses: '200': description: The updated custom field definition. content: application/json: schema: $ref: '#/components/schemas/ContactFieldDefinition' '400': description: >- Bad request — empty patch, invalid values, a standard (system) field name in place of a UUID (`System fields are read-only`), or a disallowed edit to an integration-managed field. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized — missing, malformed, revoked, or expired API key. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: >- Not found — no custom field with this ID exists in the workspace tied to your API key. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: ContactFieldDefinition: type: object properties: type: type: string enum: - standard - custom description: >- `standard` for built-in contact fields (read-only, always active), `custom` for workspace custom fields. api_name: type: string description: >- Stable identifier used in API payloads, import mappings, and merge tags (e.g. `email`, `firstName`, or a custom field's snake_case name). display_name: type: string description: Human-readable label. value_type: type: string enum: - string - number - boolean - date - email - phone description: >- Value type. Standard fields may use `email`/`phone`; custom fields are `string`, `number`, `boolean`, or `date`. is_editable: type: boolean description: >- Whether values can be edited manually in the UI. Always `false` for standard fields. status: type: string enum: - active - archived description: Field status. Standard fields are always `active`. field_definition_id: type: string format: uuid description: >- Custom field definition ID — the path parameter for `PATCH /v1/contact-fields/{fieldDefinitionId}`. Custom fields only. description: type: - string - 'null' description: Optional description of what the field stores. Custom fields only. management_mode: type: string enum: - org_managed - integration_managed description: >- Who owns the field: `org_managed` (created in the UI or via this API — fully editable) or `integration_managed` (owned by a connected integration — name, description, and status are locked). Custom fields only. provenance_kind: type: string enum: - manual_ui - import_csv - integration description: How the field was created. Custom fields only. provenance_provider: type: - string - 'null' description: >- Integration provider that created the field, when applicable. Custom fields only. provenance_reference: type: - string - 'null' description: >- Provider-side reference for the field, when applicable. Custom fields only. created_by_user_id: type: - string - 'null' description: >- Who created the field. `tented-api` for fields created via this API. Custom fields only. created_from_import_session_id: type: - string - 'null' description: >- Import session the field was created from, when `provenance_kind` is `import_csv`. Custom fields only. show_in_people_list_default: type: boolean description: >- Whether the field appears as a column in the People list by default. Custom fields only. created_at: type: string format: date-time description: Creation time. Custom fields only. updated_at: type: string format: date-time description: Last update. Custom fields only. required: - type - api_name - display_name - value_type - is_editable - status description: >- A contact field definition. Standard fields include only the six required properties; custom fields include the full definition metadata. Error: type: object properties: error: type: string description: Human-readable error message. error_code: type: string description: >- Stable machine-readable error code (present on email, blast, flow, and related endpoints, e.g. `campaign_not_ready`, `generation_in_progress`). message: type: string description: Additional human-readable context (present on some tent endpoints). code: type: string description: >- Machine-readable code used by tent creation errors (e.g. `INVALID_PROMPT_INTENT`). details: type: object additionalProperties: true description: >- Additional error context. Validation errors include `issues`: an array of `{ path, message }` objects. limit: type: integer description: Plan limit that was hit (present on `429` publish-limit errors). current: type: integer description: >- Current usage against the limit (present on `429` publish-limit errors). required: - error description: >- Error response. All errors include `error`; the other fields vary by endpoint group. securitySchemes: bearerAuth: type: http scheme: bearer description: >- Workspace API key, e.g. `Authorization: Bearer tented_...`. Create keys in Workspace Settings → API Keys. ````