> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a Messaging Service

> Update messaging service properties using JSON Patch

# Update a Messaging Service

Update a messaging service's properties using JSON Merge Patch. You can update by ID or by fully qualified name.

## Update by ID

<ParamField path="id" type="string" required>
  UUID of the messaging service to update.
</ParamField>

## Update by Name

Use `PATCH /v1/services/messagingServices/name/{fqn}` to update by fully qualified name.

<ParamField path="fqn" type="string" required>
  Fully qualified name of the messaging service (e.g., `sample_kafka`).
</ParamField>

## Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.

<ParamField body="description" type="string">
  Updated description in Markdown format.
</ParamField>

<ParamField body="displayName" type="string">
  Updated display name.
</ParamField>

<ParamField body="connection" type="object">
  Updated connection configuration.

  <Expandable title="properties">
    <ParamField body="config" type="object">
      Service-specific connection configuration.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="owners" type="array">
  Updated list of owner references.

  <Expandable title="properties">
    <ParamField body="id" type="string">
      UUID of the owner entity.
    </ParamField>

    <ParamField body="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="tags" type="array">
  Updated classification tags.

  <Expandable title="properties">
    <ParamField body="tagFQN" type="string" required>
      Fully qualified name of the tag.
    </ParamField>

    <ParamField body="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ParamField>

    <ParamField body="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="domain" type="string">
  Updated domain FQN.
</ParamField>

<RequestExample dropdown>
  ```python PATCH /v1/services/messagingServices/{id} theme={null}
  import requests

  base_url = "https://your-company.open-metadata.org/api"
  headers = {
      "Authorization": "Bearer your-jwt-token",
      "Content-Type": "application/json-patch+json"
  }

  # Update by ID
  response = requests.patch(
      f"{base_url}/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
      json=[
          {"op": "replace", "path": "/description", "value": "Updated Kafka messaging service"},
          {"op": "replace", "path": "/displayName", "value": "Sample Kafka (Updated)"}
      ],
      headers=headers
  )
  updated = response.json()
  print(f"Updated to version {updated['version']}")
  ```

  ```java PATCH /v1/services/messagingServices/{id} theme={null}
  import static org.openmetadata.sdk.fluent.MessagingServices.*;

  // Retrieve, modify, and update
  MessagingService service = MessagingServices.retrieve("469ef25e-9bdf-4d5f-8553-eb0ce8581f30");
  service.setDescription("Updated Kafka messaging service");
  MessagingService updated = MessagingServices.update(service);
  ```

  ```bash PATCH /v1/services/messagingServices/{id} theme={null}
  # Update by ID
  curl -X PATCH "{base_url}/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json-patch+json" \
    -d '[
      {"op": "replace", "path": "/description", "value": "Updated Kafka messaging service"},
      {"op": "replace", "path": "/displayName", "value": "Sample Kafka (Updated)"}
    ]'

  # Update by name
  curl -X PATCH "{base_url}/api/v1/services/messagingServices/name/sample_kafka" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json-patch+json" \
    -d '[
      {"op": "replace", "path": "/description", "value": "Updated Kafka messaging service"}
    ]'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    "name": "sample_kafka",
    "fullyQualifiedName": "sample_kafka",
    "serviceType": "Kafka",
    "description": "Updated Kafka messaging service",
    "version": 0.2,
    "updatedAt": 1769982700000,
    "updatedBy": "admin",
    "href": "http://localhost:8585/api/v1/services/messagingServices/469ef25e-9bdf-4d5f-8553-eb0ce8581f30",
    "connection": {
      "config": {
        "type": "Kafka",
        "bootstrapServers": "localhost:9092",
        "securityProtocol": "PLAINTEXT",
        "saslMechanism": "PLAIN",
        "schemaRegistryTopicSuffixName": "-value",
        "supportsMetadataExtraction": true
      }
    },
    "owners": [],
    "tags": [],
    "deleted": false,
    "domains": []
  }
  ```
</ResponseExample>

***

## Returns

Returns the updated messaging service object with the new version number.

## Response

<ResponseField name="id" type="string">
  Unique identifier for the messaging service (UUID format).
</ResponseField>

<ResponseField name="name" type="string">
  Messaging service name.
</ResponseField>

<ResponseField name="fullyQualifiedName" type="string">
  Fully qualified name of the service.
</ResponseField>

<ResponseField name="description" type="string">
  Updated description.
</ResponseField>

<ResponseField name="version" type="number">
  Incremented version number.
</ResponseField>

***

## Error Handling

| Code  | Error Type     | Description                                            |
| ----- | -------------- | ------------------------------------------------------ |
| `400` | `BAD_REQUEST`  | Invalid JSON patch or malformed request                |
| `401` | `UNAUTHORIZED` | Invalid or missing authentication token                |
| `403` | `FORBIDDEN`    | User lacks permission to update this messaging service |
| `404` | `NOT_FOUND`    | Messaging service with given ID or FQN does not exist  |
| `409` | `CONFLICT`     | Concurrent modification detected                       |