## Update a channel

`channel.update(strid, ChannelUpdateParams**kwargs)  -> ChannelUpdateResponse`

**post** `/v1/channels/{id}`

Updates `$includeInCrm` on a channel the caller can see. Only the channel owner — the member whose connected LinkedIn or WhatsApp account owns the DM — can change this. Anyone else receives `403`.

Supports idempotency via the `Idempotency-Key` header.

**[Required scope](/using-the-api/scopes/):** `channels:update`

**[Rate limit category](/using-the-api/rate-limits/):** Write

### Parameters

- `id: str`

  Unique identifier of the channel to update.

- `fields: Fields`

  Field values to update — only provided fields are modified. `$includeInCrm` is the only writable channel field. See **[Fields and relationships](/using-the-api/fields-and-relationships/)** for value type details.

  - `include_in_crm: bool`

    Whether this DM should appear in the CRM. Only the channel owner can change this.

### Returns

- `class ChannelUpdateResponse: …`

  - `id: str`

    Unique identifier for the entity.

  - `created_at: str`

    ISO 8601 timestamp of when the entity was created.

  - `fields: Dict[str, 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: Optional[FieldsValue]`

      The field value, or null if unset.

      - `str`

      - `float`

      - `bool`

      - `List[str]`

      - `class FieldsValueAddress: …`

        - `city: Optional[str]`

          City name.

        - `country: Optional[str]`

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

        - `latitude: Optional[float]`

          Latitude coordinate.

        - `longitude: Optional[float]`

          Longitude coordinate.

        - `postal_code: Optional[str]`

          Postal or ZIP code.

        - `state: Optional[str]`

          State or province.

        - `street: Optional[str]`

          Street address line 1.

        - `street2: Optional[str]`

          Street address line 2.

      - `class FieldsValueFullName: …`

        - `first_name: Optional[str]`

          The contact's first name.

        - `last_name: Optional[str]`

          The contact's last name.

    - `value_type: Literal["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"`

  - `http_link: Optional[str]`

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

  - `object_type: Literal["channel"]`

    Always `channel`.

    - `"channel"`

  - `relationships: Dict[str, Relationships]`

    Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record's role with `:asSource` or `:asDestination`, for example `?parent:asSource[contains]=account_id`.

    - `cardinality: str`

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

    - `object_type: str`

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

    - `values: List[str]`

      IDs of the related entities.

    - `directions: Optional[RelationshipsDirections]`

      Directional values for a self-referential relationship. List filters use the relationship key with `:asSource` or `:asDestination`; writes continue to use the bare key.

      - `as_destination: RelationshipsDirectionsAsDestination`

        The current record is the destination (incoming) endpoint.

        - `cardinality: Literal["HAS_ONE", "HAS_MANY"]`

          Whether this endpoint direction is `HAS_ONE` or `HAS_MANY`.

          - `"HAS_ONE"`

          - `"HAS_MANY"`

        - `values: List[str]`

          IDs of the related entities in this direction.

      - `as_source: RelationshipsDirectionsAsSource`

        The current record is the source (outgoing) endpoint.

        - `cardinality: Literal["HAS_ONE", "HAS_MANY"]`

          Whether this endpoint direction is `HAS_ONE` or `HAS_MANY`.

          - `"HAS_ONE"`

          - `"HAS_MANY"`

        - `values: List[str]`

          IDs of the related entities in this direction.

  - `updated_at: Optional[str]`

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

  - `external_id: Optional[str]`

    External identifier for the entity, or null if unset.

### Example

```python
from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
channel_update_response = client.channel.update(
    id="id",
    fields={
        "include_in_crm": True
    },
)
print(channel_update_response.id)
```

#### Response

```json
{
  "id": "chn_cm2def456ghi789",
  "createdAt": "2026-05-01T09:00:00.000Z",
  "fields": {
    "$name": {
      "value": "acme-deal-room",
      "valueType": "TEXT"
    },
    "$provider": {
      "value": "SLACK",
      "valueType": "TEXT"
    },
    "$isPublic": {
      "value": false,
      "valueType": "CHECKBOX"
    },
    "$providerChannelId": {
      "value": "C0123456789",
      "valueType": "TEXT"
    },
    "$providerCreatedAt": {
      "value": "2026-04-20T14:30:00.000Z",
      "valueType": "DATETIME"
    },
    "$includeInCrm": {
      "value": "string",
      "valueType": "CHECKBOX"
    }
  },
  "httpLink": null,
  "objectType": "channel",
  "relationships": {
    "account-slack-channel": {
      "cardinality": "has_many",
      "objectType": "account",
      "values": [
        "acc_cm0abc123def456"
      ],
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        }
      }
    },
    "opportunity-slack-channel": {
      "cardinality": "has_many",
      "objectType": "opportunity",
      "values": [
        "opp_cm1xyz456uvw789"
      ],
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        }
      }
    }
  },
  "updatedAt": "2026-05-01T09:00:00.000Z",
  "externalId": "externalId"
}
```