Create, update or delete a Verify schedule with native revision checks

curl --request POST \
  --url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/schedules/changes \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "mutation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "change": {
    "selection": {
      "kind": "journeys",
      "cuj_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "branch": "<string>",
    "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timezone": "<string>",
    "recurrence": {
      "kind": "interval",
      "minutes": 262807
    },
    "mode": "create",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": ""
  },
  "org_id": "<string>",
  "org_name": "<string>"
}
'

import requests

url = "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/schedules/changes"

payload = {
    "mutation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "change": {
        "selection": {
            "kind": "journeys",
            "cuj_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
        },
        "branch": "<string>",
        "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "timezone": "<string>",
        "recurrence": {
            "kind": "interval",
            "minutes": 262807
        },
        "mode": "create",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": ""
    },
    "org_id": "<string>",
    "org_name": "<string>"
}
headers = {
    "x-coderabbitai-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    mutation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    change: {
      selection: {kind: 'journeys', cuj_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
      branch: '<string>',
      environment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      timezone: '<string>',
      recurrence: {kind: 'interval', minutes: 262807},
      mode: 'create',
      id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      name: ''
    },
    org_id: '<string>',
    org_name: '<string>'
  })
};

fetch('https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/schedules/changes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "schedule_id": "<string>"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "head_changed",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "precondition_failed",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "payload_too_large",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "unavailable",
    "message": "<string>",
    "retry_after": 1
  }
}

POST

verify

repositories

{repository_id}

schedules

changes

Create, update or delete a Verify schedule with native revision checks

curl --request POST \
  --url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/schedules/changes \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "mutation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "change": {
    "selection": {
      "kind": "journeys",
      "cuj_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "branch": "<string>",
    "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timezone": "<string>",
    "recurrence": {
      "kind": "interval",
      "minutes": 262807
    },
    "mode": "create",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": ""
  },
  "org_id": "<string>",
  "org_name": "<string>"
}
'

import requests

url = "https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/schedules/changes"

payload = {
    "mutation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "change": {
        "selection": {
            "kind": "journeys",
            "cuj_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
        },
        "branch": "<string>",
        "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "timezone": "<string>",
        "recurrence": {
            "kind": "interval",
            "minutes": 262807
        },
        "mode": "create",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": ""
    },
    "org_id": "<string>",
    "org_name": "<string>"
}
headers = {
    "x-coderabbitai-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    mutation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    change: {
      selection: {kind: 'journeys', cuj_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
      branch: '<string>',
      environment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      timezone: '<string>',
      recurrence: {kind: 'interval', minutes: 262807},
      mode: 'create',
      id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      name: ''
    },
    org_id: '<string>',
    org_name: '<string>'
  })
};

fetch('https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/schedules/changes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "schedule_id": "<string>"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "head_changed",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "precondition_failed",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "payload_too_large",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "<string>",
    "retry_after": 1
  }
}

{
  "error": {
    "code": "unavailable",
    "message": "<string>",
    "retry_after": 1
  }
}

CLI Tool
MCP Server

coderabbit api request "/verify/repositories/$REPOSITORY_ID/schedules/changes" --input request.json

To install and sign in to the CLI, see Call from the CLI.

An agent connected to the CodeRabbit MCP server runs this operation as the change_verify_schedule tool. The connection selects the organization, so the arguments have no org_id or org_name.

{
  "method": "tools/call",
  "params": {
    "name": "change_verify_schedule",
    "arguments": {
      "repository_id": "<repository_id>",
      "mutation_id": "<mutation_id>",
      "change": "<change>"
    }
  }
}

Authorizations

x-coderabbitai-api-key

string

header

required

See Authentication for the key types and where to create a key.

Path Parameters

repository_id

string<uuid>

required

Verify registration UUID returned as id by list_verify_repositories; not the provider repository ID.

Body

application/json

mutation_id

string<uuid>

required

Caller-generated UUID for retrying the same schedule change.

change

object

required

Option 1
Option 2
Option 3

Show child attributes

org_id

string

Organization for a workspace key: the Git-provider organization ID (scope.provider_organization_id) or the CodeRabbit organization ID (scope.id, or id from list organizations). Supply either org_id or org_name, never both. Omit for organization keys and MCP connections.

Minimum string length: 1

org_name

string

GitHub organization login, such as coderabbitai, not its display name. Matched case-insensitively within the authenticated workspace. Supply either org_name or org_id, never both; omit for organization keys and MCP connections.

Pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$

Response

schedule_id

string

required

Basics

Clients

Guides

API reference

Create, update or delete a Verify schedule with native revision checks

Authorizations

Path Parameters

Body

Response