## Update a custom object record

`client.object.update(stringid, ObjectUpdateParamsparams, RequestOptionsoptions?): ObjectUpdateResponse`

**post** `/v1/objects/{entitySlug}/values/{id}`

Updates an existing record by ID for the specified custom object type. Only included fields and relationships are modified.

### Parameters

- `id: string`

  The ID of the record to update.

- `params: ObjectUpdateParams`

  - `entitySlug: string`

    Path param: The slug of the custom object type.

  - `fields?: Record<string, string | number | boolean | 3 more | null>`

    Body param: Field names to values. Only provided fields are modified.

    - `string`

    - `number`

    - `boolean`

    - `Array<string>`

    - `Address`

      - `city?: string | null`

        City name.

      - `country?: string | null`

        2-letter ISO 3166-1 alpha-2 country code.

      - `latitude?: number | null`

        Latitude coordinate.

      - `longitude?: number | null`

        Longitude coordinate.

      - `postalCode?: string | null`

        Postal or ZIP code.

      - `state?: string | null`

        State or province.

      - `street?: string | null`

        Street address line 1.

      - `street2?: string | null`

        Street address line 2.

    - `FullName`

      - `firstName?: string | null`

        The contact's first name.

      - `lastName?: string | null`

        The contact's last name.

  - `relationships?: Record<string, Relationships>`

    Body param: Relationship names to operations (`add`, `remove`, or `replace`).

    - `add?: string | Array<string>`

      Entity ID(s) to add to the relationship.

      - `string`

      - `Array<string>`

    - `remove?: string | Array<string>`

      Entity ID(s) to remove from the relationship.

      - `string`

      - `Array<string>`

    - `replace?: string | Array<string> | null`

      A single entity ID or an array of entity IDs.

      - `string`

      - `Array<string>`

### Returns

- `ObjectUpdateResponse`

  - `id: string`

    Unique identifier for the entity.

  - `createdAt: string`

    ISO 8601 timestamp of when the entity was created.

  - `fields: Record<string, Fields>`

    Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.

    - `value: string | number | boolean | 3 more | null`

      The field value, or null if unset.

      - `string`

      - `number`

      - `boolean`

      - `Array<string>`

      - `Address`

        - `city?: string | null`

          City name.

        - `country?: string | null`

          2-letter ISO 3166-1 alpha-2 country code.

        - `latitude?: number | null`

          Latitude coordinate.

        - `longitude?: number | null`

          Longitude coordinate.

        - `postalCode?: string | null`

          Postal or ZIP code.

        - `state?: string | null`

          State or province.

        - `street?: string | null`

          Street address line 1.

        - `street2?: string | null`

          Street address line 2.

      - `FullName`

        - `firstName?: string | null`

          The contact's first name.

        - `lastName?: string | null`

          The contact's last name.

    - `valueType: "ADDRESS" | "CHECKBOX" | "CURRENCY" | 12 more`

      The data type of the field.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

      - `"HTML"`

  - `httpLink: string | null`

    URL to view the entity in the Lightfield web app, or null.

  - `relationships: Record<string, Relationships>`

    Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).

    - `cardinality: string`

      Whether the relationship is `has_one` or `has_many`.

    - `objectType: string`

      The type of the related object (e.g. `account`, `contact`).

    - `values: Array<string>`

      IDs of the related entities.

  - `updatedAt: string | null`

    ISO 8601 timestamp of when the entity was last updated, or null.

  - `externalId?: string | null`

    External identifier for the entity, or null if unset.

### Example

```typescript
import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const objectUpdateResponse = await client.object.update('id', { entitySlug: 'entitySlug' });

console.log(objectUpdateResponse.id);
```

#### Response

```json
{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}
```