## Update a custom object record

`client.Object.Update(ctx, id, params) (*ObjectUpdateResponse, error)`

**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 param.Field[string]`

    Path param: The slug of the custom object type.

  - `Fields param.Field[map[string, ObjectUpdateParamsFieldUnion]]`

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

    - `string`

    - `float64`

    - `bool`

    - `type ObjectUpdateParamsFieldArray []string`

    - `type ObjectUpdateParamsFieldAddress struct{…}`

      - `City string`

        City name.

      - `Country string`

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

      - `Latitude float64`

        Latitude coordinate.

      - `Longitude float64`

        Longitude coordinate.

      - `PostalCode string`

        Postal or ZIP code.

      - `State string`

        State or province.

      - `Street string`

        Street address line 1.

      - `Street2 string`

        Street address line 2.

    - `type ObjectUpdateParamsFieldFullName struct{…}`

      - `FirstName string`

        The contact's first name.

      - `LastName string`

        The contact's last name.

  - `Relationships param.Field[map[string, ObjectUpdateParamsRelationship]]`

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

    - `Add ObjectUpdateParamsRelationshipAddUnion`

      Entity ID(s) to add to the relationship.

      - `string`

      - `type ObjectUpdateParamsRelationshipAddArray []string`

    - `Remove ObjectUpdateParamsRelationshipRemoveUnion`

      Entity ID(s) to remove from the relationship.

      - `string`

      - `type ObjectUpdateParamsRelationshipRemoveArray []string`

    - `Replace ObjectUpdateParamsRelationshipReplaceUnion`

      A single entity ID or an array of entity IDs.

      - `string`

      - `type ObjectUpdateParamsRelationshipReplaceArray []string`

### Returns

- `type ObjectUpdateResponse struct{…}`

  - `ID string`

    Unique identifier for the entity.

  - `CreatedAt string`

    ISO 8601 timestamp of when the entity was created.

  - `Fields map[string, ObjectUpdateResponseField]`

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

    - `Value ObjectUpdateResponseFieldValueUnion`

      The field value, or null if unset.

      - `string`

      - `float64`

      - `bool`

      - `type ObjectUpdateResponseFieldValueArray []string`

      - `type ObjectUpdateResponseFieldValueAddress struct{…}`

        - `City string`

          City name.

        - `Country string`

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

        - `Latitude float64`

          Latitude coordinate.

        - `Longitude float64`

          Longitude coordinate.

        - `PostalCode string`

          Postal or ZIP code.

        - `State string`

          State or province.

        - `Street string`

          Street address line 1.

        - `Street2 string`

          Street address line 2.

      - `type ObjectUpdateResponseFieldValueFullName struct{…}`

        - `FirstName string`

          The contact's first name.

        - `LastName string`

          The contact's last name.

    - `ValueType string`

      The data type of the field.

      - `const ObjectUpdateResponseFieldValueTypeAddress ObjectUpdateResponseFieldValueType = "ADDRESS"`

      - `const ObjectUpdateResponseFieldValueTypeCheckbox ObjectUpdateResponseFieldValueType = "CHECKBOX"`

      - `const ObjectUpdateResponseFieldValueTypeCurrency ObjectUpdateResponseFieldValueType = "CURRENCY"`

      - `const ObjectUpdateResponseFieldValueTypeDatetime ObjectUpdateResponseFieldValueType = "DATETIME"`

      - `const ObjectUpdateResponseFieldValueTypeEmail ObjectUpdateResponseFieldValueType = "EMAIL"`

      - `const ObjectUpdateResponseFieldValueTypeFullName ObjectUpdateResponseFieldValueType = "FULL_NAME"`

      - `const ObjectUpdateResponseFieldValueTypeMarkdown ObjectUpdateResponseFieldValueType = "MARKDOWN"`

      - `const ObjectUpdateResponseFieldValueTypeMultiSelect ObjectUpdateResponseFieldValueType = "MULTI_SELECT"`

      - `const ObjectUpdateResponseFieldValueTypeNumber ObjectUpdateResponseFieldValueType = "NUMBER"`

      - `const ObjectUpdateResponseFieldValueTypeSingleSelect ObjectUpdateResponseFieldValueType = "SINGLE_SELECT"`

      - `const ObjectUpdateResponseFieldValueTypeSocialHandle ObjectUpdateResponseFieldValueType = "SOCIAL_HANDLE"`

      - `const ObjectUpdateResponseFieldValueTypeTelephone ObjectUpdateResponseFieldValueType = "TELEPHONE"`

      - `const ObjectUpdateResponseFieldValueTypeText ObjectUpdateResponseFieldValueType = "TEXT"`

      - `const ObjectUpdateResponseFieldValueTypeURL ObjectUpdateResponseFieldValueType = "URL"`

      - `const ObjectUpdateResponseFieldValueTypeHTML ObjectUpdateResponseFieldValueType = "HTML"`

  - `HTTPLink string`

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

  - `Relationships map[string, ObjectUpdateResponseRelationship]`

    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 []string`

      IDs of the related entities.

  - `UpdatedAt string`

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

  - `ExternalID string`

    External identifier for the entity, or null if unset.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  objectUpdateResponse, err := client.Object.Update(
    context.TODO(),
    "id",
    githubcomlightfldlightfieldgo.ObjectUpdateParams{
      EntitySlug: "entitySlug",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
}
```