Change what a commitment covers or when it next runs

{
  "data": {
    "id": "string",
    "outcome": "string",
    "completion": "string",
    "nextAction": "string",
    "schedule": "string",
    "state": "active",
    "origin": "chat",
    "background": true,
    "originEntryId": "string",
    "nextWakeAt": "2026-10-08T09:00:00-04:00",
    "waitingFor": "string",
    "blocker": "string",
    "version": 1,
    "running": true,
    "updatedAt": "2026-10-08T09:00:00-04:00",
    "attempts": {
      "total": 1,
      "succeeded": 1,
      "failed": 1
    },
    "receipts": [
      {
        "attemptId": "string",
        "state": "running",
        "startedAt": "2026-10-08T09:00:00-04:00",
        "finishedAt": "2026-10-08T09:00:00-04:00",
        "outcome": "unverified",
        "outcomeDetail": "string",
        "result": {
          "fileId": "string",
          "name": "string"
        },
        "delivery": {
          "state": "none",
          "at": "2026-10-08T09:00:00-04:00",
          "entryId": "string",
          "reason": "string"
        }
      }
    ]
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

commitmentIdstringRequiredformat: "^cmt_[0-9A-HJKMNP-TV-Z]{26}$"

Request

This endpoint expects an object.

versionintegerRequired-9007199254740991-9007199254740991

outcomestringOptional1-400 characters

completionstringOptional1-400 characters

nextActionstringOptional1-2000 characters

schedulestringOptional1-120 characters

nextWakeAtdatetimeOptional

Response

Change what a commitment covers or when it next runs

dataobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error