archive_behavior
Archives a Behavior so it schedules no new Occurrences, with an optional archive note. History, notes, and past Occurrences are kept, and restore_behavior reverses it. Archiving a parent Behavior also archives its active sub-behaviors. Nothing is deleted. Archiving an archived Behavior changes nothing.
Permission and annotations
Required scope: cadence.behaviors.write. Contract 1.7.0; available since 1.0.0.
title: “Archive Behavior”readOnlyHint: falsedestructiveHint: trueidempotentHint: trueopenWorldHint: false
Modifies the Behavior and stops future scheduling, which Claude’s review criteria treat as destructive, so destructiveHint is true. It is reversible with restore_behavior, so OpenAI’s stricter reading would allow false; the conservative value keeps confirmation in both clients. Repeating it changes nothing, so idempotentHint is true. openWorldHint is false.
Input
Required means required within the containing object. Variant fields apply only to that variant; children of nullable values apply when non-null. Unknown fields are rejected.
| Field | Required | Type | Meaning and constraints |
|---|---|---|---|
behavior_id |
yes | string | Behavior id.; format: uuid |
archive_note |
no | string | Optional reason or context for archiving.; maxLength: 2000; pattern: ^[^\u0000-\u0008\u000b\u000c\u000e-\u001f\u007f]*$ |
expected_revision |
no | string | Opaque version token of this record. Send it back as expected_revision to avoid overwriting a newer change.; minLength: 1; maxLength: 128; pattern: ^[A-Za-z0-9._:-]+$ |
idempotency_key |
no | string | Optional client-chosen key. Repeating a call with the same key and input within 24 hours returns the first result and changes nothing.; minLength: 8; maxLength: 128; pattern: ^[A-Za-z0-9._:-]+$ |
Output
Required means required within the containing object. Variant fields apply only to that variant; children of nullable values apply when non-null. Unknown fields are rejected.
| Field | Required | Type | Meaning and constraints |
|---|---|---|---|
behavior |
yes | object | A Behavior: a recurring thing the user tracks (a habit, routine, or recurring task). |
behavior.id |
yes | string | format: uuid |
behavior.title |
yes | string | |
behavior.description |
yes | string or null | |
behavior.location_text |
yes | string or null | |
behavior.category |
yes | object or null | |
behavior.category.id |
yes | string | format: uuid |
behavior.category.name |
yes | string | |
behavior.state |
yes | string | Archived Behaviors keep their history but schedule no new Occurrences.; Values: active, archived |
behavior.archived_at |
yes | string or null | format: date-time; pattern: [Zz]$ |
behavior.auto_archived_at |
yes | string or null | Set on Behaviors that an end date archived automatically before Cadence stopped archiving on an end. New ends never set it.; format: date-time; pattern: [Zz]$ |
behavior.run_state |
yes | string | running schedules Occurrences; ended has passed its end and paused is inside a pause, both still active and shown under Not running; archived is archived.; Values: running, ended, paused, archived |
behavior.is_opportunity |
yes | boolean | True when the Behavior is available as an opportunity: the person can add it to today when there is room, with or without a schedule (contract 1.6.0). |
behavior.end_on |
yes | string or null | Last local day the Behavior runs. Null when it has no end.; format: date |
behavior.end_time |
yes | string or null | Local time on end_on when it stops. Null means it stops at the end of that day.; pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$ |
behavior.pause |
yes | object or null | The current or upcoming pause. Null when none is set or the pause is over. |
behavior.pause.from_on |
yes | string | First paused local day.; format: date |
behavior.pause.from_time |
yes | string or null | Local time on from_on when the pause starts. Null means the start of that day.; pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$ |
behavior.pause.back_on |
yes | string | Local day the Behavior runs again by itself, from the start of the day.; format: date |
behavior.end_date |
yes | string or null | Deprecated: read end_on. The day after end_on, kept for one minor version.; format: date |
behavior.default_duration_minutes |
yes | integer or null | minimum: 1 |
behavior.timezone |
yes | string | IANA timezone name.; minLength: 1; maxLength: 64; pattern: ^[A-Za-z0-9_+\-/]+$ |
behavior.schedules |
yes | array | |
behavior.schedules[] |
yes | object | |
behavior.schedules[].id |
yes | string | format: uuid |
behavior.schedules[].recurrence |
yes | one of several shapes | Structured recurrence rule. Natural-language rules and cron syntax are not accepted. |
behavior.schedules[].recurrence.frequency |
yes | string | Value: daily |
behavior.schedules[].recurrence.interval |
yes | integer | Repeat every N days. 1 means every day.; minimum: 1 |
behavior.schedules[].recurrence.frequency |
yes | string | Value: interval_days |
behavior.schedules[].recurrence.interval_days |
yes | integer | Repeat every N days counted from the start date.; minimum: 1 |
behavior.schedules[].recurrence.frequency |
yes | string | Value: weekly |
behavior.schedules[].recurrence.interval |
yes | integer | Repeat every N weeks. 1 means every week.; minimum: 1 |
behavior.schedules[].recurrence.days_of_week |
yes | array | minItems: 1; maxItems: 7; uniqueItems: true |
behavior.schedules[].recurrence.days_of_week[] |
yes | string | Values: monday, tuesday, wednesday, thursday, friday, saturday, sunday |
behavior.schedules[].recurrence.frequency |
yes | string | Value: monthly |
behavior.schedules[].recurrence.interval |
yes | integer | Repeat every N months.; minimum: 1 |
behavior.schedules[].recurrence.day_of_month |
yes | integer | Day of the month. In months without this day, the last day of the month is used.; minimum: 1; maximum: 31 |
behavior.schedules[].recurrence_summary |
yes | string | Plain-language recurrence, for example Weekly on Monday and Thursday. |
behavior.schedules[].time_entries |
yes | array | |
behavior.schedules[].time_entries[] |
yes | object | |
behavior.schedules[].time_entries[].id |
yes | string | format: uuid |
behavior.schedules[].time_entries[].kind |
yes | string | Values: exact, range |
behavior.schedules[].time_entries[].preset |
yes | string or null | Values: morning, afternoon, evening, night, null |
behavior.schedules[].time_entries[].start_time |
yes | string | Local wall-clock time, 24-hour HH:MM.; pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$ |
behavior.schedules[].time_entries[].end_time |
yes | string or null | Local wall-clock time, 24-hour HH:MM.; pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$ |
behavior.schedules[].time_entries[].label |
yes | string | Display label, for example 7:30 AM or Morning. |
behavior.schedules[].time_summary |
yes | string | |
behavior.schedule_summary |
yes | string | |
behavior.reminders |
yes | object | |
behavior.reminders.browser_enabled |
yes | boolean | |
behavior.reminders.email_enabled |
yes | boolean | |
behavior.reminders.offset_minutes |
yes | integer | minimum: 0 |
behavior.reminders.summary |
yes | string | |
behavior.archive_notes |
yes | array | |
behavior.archive_notes[] |
yes | object | |
behavior.archive_notes[].id |
yes | string | format: uuid |
behavior.archive_notes[].archived_at |
yes | string | format: date-time; pattern: [Zz]$ |
behavior.archive_notes[].note |
yes | string or null | |
behavior.archive_notes[].updated_at |
yes | string | format: date-time; pattern: [Zz]$ |
behavior.external_ref |
yes | string or null | This client’s external record id, when it set one at creation. |
behavior.parent_behavior_id |
yes | string or null | Parent Behavior id when this is a sub-behavior. Null for a top-level Behavior (contract 1.7.0).; format: uuid |
behavior.sub_behavior_sort_order |
yes | integer | Position among the parent’s sub-behaviors, 0 first. 0 for a top-level Behavior.; minimum: 0; maximum: 9999 |
behavior.inherit_parent_schedule |
yes | boolean | True when this sub-behavior follows its parent’s schedule; its schedules then mirror the parent’s. Always false for a top-level Behavior. |
behavior.sub_behaviors |
yes | array | This Behavior’s sub-behaviors in display order, archived ones included. Empty for a sub-behavior or a Behavior without any. |
behavior.sub_behaviors[] |
yes | object | |
behavior.sub_behaviors[].id |
yes | string | format: uuid |
behavior.sub_behaviors[].title |
yes | string | |
behavior.sub_behaviors[].sub_behavior_sort_order |
yes | integer | Position among the parent’s sub-behaviors, 0 first.; minimum: 0; maximum: 9999 |
behavior.sub_behaviors[].inherit_parent_schedule |
yes | boolean | True when the sub-behavior follows its parent’s schedule. |
behavior.sub_behaviors[].active |
yes | boolean | False when the sub-behavior is archived. |
behavior.sub_behaviors[].run_state |
yes | string | Values: running, ended, paused, archived |
behavior.created_at |
yes | string | format: date-time; pattern: [Zz]$ |
behavior.updated_at |
yes | string | format: date-time; pattern: [Zz]$ |
behavior.revision |
yes | string | Opaque version token of this record. Send it back as expected_revision to avoid overwriting a newer change.; minLength: 1; maxLength: 128; pattern: ^[A-Za-z0-9._:-]+$ |
changed |
yes | boolean | False when the Behavior was already archived. |
Example call
Synthetic contract fixture. Replace identifiers and dates with records returned for your account. This is the SDK tools/call payload, not a complete HTTP request.
{
"name": "archive_behavior",
"arguments": {
"behavior_id": "00000001-1111-4111-8111-000000000001",
"archive_note": "Paused for travel.",
"expected_revision": "b1.7"
}
}
Example result
Synthetic success data from a contract fixture, shown as structuredContent. Input and output examples validate independently; they are not a recorded transaction.
{
"behavior": {
"id": "00000002-1111-4111-8111-000000000002",
"title": "Vitamin D",
"description": "Twenty minutes outside.",
"location_text": null,
"category": null,
"state": "archived",
"archived_at": "2026-10-01T14:00:00Z",
"auto_archived_at": null,
"run_state": "archived",
"is_opportunity": false,
"end_on": null,
"end_time": null,
"pause": null,
"end_date": null,
"default_duration_minutes": 20,
"timezone": "America/New_York",
"schedules": [
{
"id": "00000006-1111-4111-8111-000000000006",
"recurrence": {
"frequency": "daily",
"interval": 1
},
"recurrence_summary": "Daily",
"time_entries": [
{
"id": "00000007-1111-4111-8111-000000000007",
"kind": "exact",
"preset": null,
"start_time": "09:00",
"end_time": null,
"label": "9:00 AM"
}
],
"time_summary": "9:00 AM"
}
],
"schedule_summary": "Weekly on Monday and Thursday at 7:30 AM and Evening",
"reminders": {
"browser_enabled": true,
"email_enabled": false,
"offset_minutes": 0,
"summary": "Browser reminder at the scheduled time"
},
"archive_notes": [
{
"id": "00000009-1111-4111-8111-000000000009",
"archived_at": "2026-10-01T14:00:00Z",
"note": "Doctor said to stop.",
"updated_at": "2026-10-01T14:00:00Z"
}
],
"external_ref": "facets:rec_42",
"parent_behavior_id": null,
"sub_behavior_sort_order": 0,
"inherit_parent_schedule": false,
"sub_behaviors": [],
"created_at": "2026-09-01T12:00:00Z",
"updated_at": "2026-10-18T13:00:00Z",
"revision": "b1.2026-10-18T13:00:00Z"
},
"changed": true
}
Errors
invalid_input: The input does not match the tool’s schema or rules.field_errorsnames each problem.authentication_required: The access token is missing, expired, revoked, or issued for another resource. Reconnect Cadence.rate_limited: Too many requests for this connection. Retry afterretry_after_seconds.service_unavailable: Cadence integrations are temporarily unavailable.internal_error: Cadence could not complete the request. Nothing is assumed to have changed; retry once with the sameidempotency_key.insufficient_scope: The connection does not include the permission this tool needs.required_scopeslists it.not_found: No record with that id exists for this account.conflict: The record changed since it was read:expected_statusorexpected_revisionis stale. Nothing changed.idempotency_key_reused: Theidempotency_keywas already used with a different input. Use a new key for a new request.
Output size limits can also return limit_exceeded. See error handling, limits, and safe retries.