--- title: Update a Telemetry Destination url: https://platform.claude.com/docs/en/api/php/beta/organization/telemetry_destinations/update --- # Update a Telemetry Destination `$client->beta->organization->telemetryDestinations->update(string destinationID, ?string displayName, ?string endpointURL, ?array headers, ?TelemetryDestinationStateParams state, ?TelemetryDestinationTracesParams traces, ?TelemetryDestinationWorkspacesParams workspaces, ?list betas): TelemetryDestination` **POST** `/v1/organizations/telemetry_destinations/{destination_id}` Change a telemetry destination's settings, its state, or which workspaces it covers. Send at least one field. Omitted fields keep their stored values, except the registered headers, which a change of the endpoint's hostname or port removes. Only `display_name`, `traces`, `traces.endpoint_url`, `traces.content_mode`, `traces.max_content_bytes`, and individual `headers` values accept `null`. If another request changes the destination while the update runs, the API returns a 409 `conflict_error`. Read the destination again, then retry the update. See the [OpenTelemetry export guide](https://platform.claude.com/docs/en/manage-claude/opentelemetry?sdk_languages=php#delivery-and-health) to learn more about changing a destination. ## Parameters - `destinationID: string` (path parameter) ID of the destination (`tdst_...`). - `displayName?: optional string` New human-readable name, 1 to 255 characters. Null clears it. - `endpointURL?: optional string` The new base URL of the destination's OTLP/HTTP endpoint. The same rules as on create apply. A change of hostname or port first removes every registered header, so send the headers for the new endpoint in the same request. When the destination has a `traces.endpoint_url`, such a change must also set `traces.endpoint_url` to a URL with the new hostname and port, or to `null`. A change of the path alone keeps the headers. - `headers?: optional array` Headers to set or remove. The API merges them into the destination's headers by name. Names compare case-insensitively. A string value sets or replaces that header. A `null` value removes it. Headers that you omit don't change. The field itself can't be `null`. A request that sets a header value must also include `endpoint_url`. The current URL is accepted. The resulting set must stay within the same limits as on create. When the request sets a value, each stored value that it doesn't set counts as 4,096 bytes toward the 16,384-byte limit, because you can't read its real length. So to change one header of a destination that has four or more other headers, send the values of the others again in the same request. - `state?: optional TelemetryDestinationStateParams` Whether the destination receives deliveries after the update. The field can't be `null`. - `traces?: optional TelemetryDestinationTracesParams` The traces settings to change. Omitted settings keep their stored values. `null` sets every traces setting to its create default. - `workspaces?: optional TelemetryDestinationWorkspacesParams` The new workspace scope, in the same form as on create. The field can't be `null`. The API refuses an update that changes the type or sends `workspace_ids` while the destination's list has more than 750 workspaces. Remove workspaces one at a time until 750 or fewer remain, then send the update again. - `betas?: optional list` (header parameter) This endpoint is in beta: requests must send `telemetry-destinations-2026-08-11` in this header. ## Returns - `class TelemetryDestination` - `"telemetry_destination" type` - `string id` The unique ID of the destination (`tdst_...`). - `\Datetime createdAt` Time the destination was created. - `TelemetryDestinationDeliveryHealth deliveryHealth` The most recent delivery results for this destination. - `?string displayName` Human-readable name for the destination. Null when none was set. - `string endpointURL` The base URL of the destination's OTLP/HTTP endpoint, exactly as registered. The API appends the per-signal path, such as `/v1/traces`, on delivery, unless `traces.endpoint_url` is set. - `list headerNames` Names of the registered request headers. Header values are write-only and are never returned. - `TelemetryDestinationState state` Whether the destination receives deliveries. - `TelemetryDestinationTraces traces` The destination's settings for the traces it receives. - `\Datetime updatedAt` Time of the last change to the destination's configuration or state. Changes to `delivery_health` don't change it. An update that sets a header value always changes it, even when the value is the same as before. Adding or removing a single workspace on the destination's list doesn't change it. An update that changes the list does. - `TelemetryDestinationWorkspaces workspaces` Which of the organization's workspaces the destination covers. ## Example ```php beta ->organization ->telemetryDestinations ->update( 'destination_id', displayName: 'display_name', endpointURL: 'endpoint_url', headers: ['foo' => 'string'], state: ['type' => 'enabled'], traces: [ 'contentMode' => TelemetryDestinationContentMode::METADATA_ONLY, 'enabled' => true, 'endpointURL' => 'endpoint_url', 'maxContentBytes' => 0, ], workspaces: ['type' => 'all'], betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], ); var_dump($betaTelemetryDestination); ``` ### Response (200) ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "delivery_health": { "last_error": "last_error", "last_error_at": "2019-12-27T18:11:19.117Z", "last_success_at": "2019-12-27T18:11:19.117Z" }, "display_name": "display_name", "endpoint_url": "endpoint_url", "header_names": [ "string" ], "state": { "type": "enabled" }, "traces": { "content_mode": "metadata_only", "enabled": true, "endpoint_url": "endpoint_url", "max_content_bytes": 0 }, "type": "telemetry_destination", "updated_at": "2019-12-27T18:11:19.117Z", "workspaces": { "type": "all" } } ```