Skip to content
campaiDeveloper
campai.com

Misc · Todo · Topics

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

Archive todo topic

Archives a todo topic for an organization while preserving existing todo references. It takes organizationId and topicId and returns no value.

Permissions

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

Who may call it

  • The caller must have access to the organization.
  • The caller needs the todoTopic.edit permission.

Request

Path parameters

  • organizationIdidrequired
  • topicIdidrequired
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/archive' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

No response body is specified.

What else happens

  • Sets archivedAt and archivedBy on the matching todo topic.

Errors

Other errors

StatusErrorWhen
404The todo topic was not foundIf no unarchived topic matches the organization and topic IDs, the endpoint returns HTTP 404 NOT_FOUND with key routes.misc.todo.topics.notFound.

Errors nearly every request can meet are listed under Errors.