Skip to content
campaiDeveloper
campai.com

Misc · Todo · Topics

POST/{organizationId}/misc/todo/topics/{topicId}/details

Update todo topic details

Updates a todo topic's name, color, and description using its organization ID, topic ID, and expected revision. It also updates the topic name and color on associated todo items when either changes. The endpoint returns no content.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • Requires organization access and the todoTopic.edit permission.

Request

Path parameters

  • organizationIdidrequired
  • topicIdidrequired

Body

Content-Type: application/json

  • revisionintegerrequired

    at least 0

  • namestringrequired

    1–80 characters

  • colorstringrequired
    22 values
    slate gray zinc neutral stone red orange amber yellow lime green emerald teal cyan sky blue indigo violet purple fuchsia pink rose
  • descriptionstringrequired

    at most 10000 characters

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/topics/YOUR_TOPIC_ID/details' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

No response body is specified.

What else happens

  • Updates the topic details and increments its revision.
  • If the topic's name or color changes, updates both values on associated todo items in the organization.

Errors

Other errors

StatusErrorWhen
404The todo topic was not foundIf the topic is not found in the organization, the endpoint returns HTTP 404 with key routes.misc.todo.topics.notFound.
409This topic changed while you were editing it. Reload it and apply your changes again.If the topic's revision differs from the supplied revision, the endpoint returns HTTP 409 with key routes.misc.todo.topics.changed.
409This topic changed while you were editing it. Reload it and apply your changes again.If the topic update no longer matches the expected revision, the endpoint returns HTTP 409 with key routes.misc.todo.topics.changed.

Errors nearly every request can meet are listed under Errors.