Skip to main content
PATCH
https://sandbox.getcollate.io/api
/
v1
/
services
/
messagingServices
/
{id}
PATCH /v1/services/messagingServices/{id}
import requests

base_url = "https://your-company.getcollate.io/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']}")
{
  "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": []
}

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

id
string
required
UUID of the messaging service to update.

Update by Name

Use PATCH /v1/services/messagingServices/name/{fqn} to update by fully qualified name.
fqn
string
required
Fully qualified name of the messaging service (e.g., sample_kafka).

Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.
description
string
Updated description in Markdown format.
displayName
string
Updated display name.
connection
object
Updated connection configuration.
owners
array
Updated list of owner references.
tags
array
Updated classification tags.
domain
string
Updated domain FQN.
PATCH /v1/services/messagingServices/{id}
import requests

base_url = "https://your-company.getcollate.io/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']}")
{
  "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": []
}

Returns

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

Response

id
string
Unique identifier for the messaging service (UUID format).
name
string
Messaging service name.
fullyQualifiedName
string
Fully qualified name of the service.
description
string
Updated description.
version
number
Incremented version number.

Error Handling

CodeError TypeDescription
400BAD_REQUESTInvalid JSON patch or malformed request
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to update this messaging service
404NOT_FOUNDMessaging service with given ID or FQN does not exist
409CONFLICTConcurrent modification detected