Skip to main content
PATCH
/
projects
/
{projectIdOrName}
/
topics
/
{topicId}
Update a topic
curl --request PATCH \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/topics/{topicId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "label": "Updated System Alerts"
}'
{
  "id": "<string>",
  "name": "system-alerts",
  "projectId": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

The Ampersand project ID or project name.

​
topicId
string
required

The topic ID.

Body

application/json
​
label
string
required

A human-readable label for the topic.

Example:

"Updated System Alerts"

Response

Updated

​
id
string
required

The topic ID.

​
name
string
required

The name of the topic. Must contain only letters, numbers, and dashes.

Maximum length: 64
Example:

"system-alerts"

​
projectId
string
required

The Ampersand project ID.

​
createTime
string<date-time>
required

The time when the topic was created.

​
updateTime
string<date-time>

The time when the topic was last updated.