Skip to main content
PUT
/
v0
/
topics
/
{id}
Update a topic
curl --request PUT \
  --url https://api.avidoai.com/v0/topics/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "title": "Code Quality",
  "assignedTo": "user_789012"
}
'
{
  "data": {
    "id": "789e4567-e89b-12d3-a456-426614174000",
    "orgId": "org_123456",
    "title": "Code Quality",
    "baseline": 0.85,
    "isVerified": false,
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "applicationId": "456e4567-e89b-12d3-a456-426614174000",
    "quickstartId": "123e4567-e89b-12d3-a456-426614174000",
    "assignedTo": "user_789012",
    "assignedUser": {
      "id": "user_789012",
      "name": "John Doe",
      "email": "john@example.com",
      "image": "https://example.com/avatar.jpg"
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

​
id
string<uuid>
required

The unique identifier of the topic

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"789e4567-e89b-12d3-a456-426614174000"

Body

application/json

Request body for updating a topic

​
title
string

Title of the topic

Minimum string length: 1
Example:

"Code Quality"

​
assignedTo
string · null · null

User ID to assign the topic to, or null to unassign

Example:

"user_789012"

Response

Successfully updated topic

Successful response containing the topic data

​
data
Topic · object
required

Details about a single Topic