Skip to main content
PATCH
TypeScript

Authorizations

Authorization
string
header
required

Project-bound Apollo Signal API key. Keys begin with ap_signal_ and must carry the permission shown on the operation.

Path Parameters

projectId
string
required

Project identifier. For API-key authentication, it must match the project bound to the key.

topicId
string
required

The ID of the topic to update.

Body

application/json

Fields to update. All fields are optional.

Topic fields to replace; omitted fields remain unchanged.

description
string

New developer-facing topic description.

name
string

New topic name after trimming; 1 to 200 characters.

Maximum string length: 200
visibility
enum<string>

New topic visibility.

Available options:
public,
private

Response

Topic updated successfully.

createdAt
string
required
defaultSubscription
string
required
id
string
required
name
string
required
object
string
required
optInCount
integer<int32>
required
optOutCount
integer<int32>
required
projectId
string
required
updatedAt
string
required
visibility
string
required
description
string