---
title: "Update custom fields on a custom object"
method: POST
path: "/objects/{id}/customFields"
tags: ["Objects"]
---

# Update custom fields on a custom object

`POST /objects/{id}/customFields`

## Request

- Base URL: `https://api.commonroom.io/api/v2`
- URL: `https://api.commonroom.io/api/v2/objects/{id}/customFields`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/commonroom/apis/common-room-api-v2/docs/objects/:id/customFields/post.ts> (a function with typed inputs; its response is checked against the schema)

Set Common Room custom-field values on a custom object record.

## Path parameters

- `id` string, required

## Request body

- object
  - `customFields` object[], required
    - `customFieldId` string, required: Custom field ID (format `cf_<number>`)
    - `customFieldValue` union, required: A typed custom-field value. The `type` discriminator indicates the value's runtime type.
      - object
        - `type` 'string', required
        - `value` string, required
      - object
        - `type` 'url', required
        - `value` string, uri, required
      - object
        - `type` 'int', required
        - `value` integer, required
      - object
        - `type` 'number', required
        - `value` number, required
      - object
        - `type` 'date', required
        - `value` string, date-time, required
      - object
        - `type` 'boolean', required
        - `value` boolean, required

## Response `200`

Updated custom object

- CustomObjectResponse
  - `success` true, required
  - `data` ApiCustomObject, required
    - `id` string, required: Prefixed custom object ID (format `co_<number>`)
    - `name` string, required: The object's display name
    - `url` string, uri: Common Room URL for this custom object
    - `recordKey` string: External record key for this object
    - `tags` string[]: Prefixed label IDs (format `l_<number>`)
    - `customFields` object: Map of custom-field ID (format `cf_<number>`) to its typed value.

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Object not found
- `429`: Rate Limited

---

[API](https://skmtc.dev/commonroom/apis/common-room-api-v2.md) - [All operations](https://skmtc.dev/commonroom/apis/common-room-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/commonroom/apis/common-room-api-v2/revisions/865d4d43dadf?raw)