Update or archive a user journey with native revision checks

curl --request PUT \
  --url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys/{cuj_id} \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "expected_list_revision": 123,
  "expected_revision": 123,
  "org_id": "<string>",
  "org_name": "<string>",
  "archive": false
}
'

import requests

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

payload = {
    "expected_list_revision": 123,
    "expected_revision": 123,
    "org_id": "<string>",
    "org_name": "<string>",
    "archive": False
}
headers = {
    "x-coderabbitai-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    expected_list_revision: 123,
    expected_revision: 123,
    org_id: '<string>',
    org_name: '<string>',
    archive: false
  })
};

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

{
  "journey_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
  }
}

PUT

verify

repositories

{repository_id}

journeys

{cuj_id}

Update or archive a user journey with native revision checks

curl --request PUT \
  --url https://api.coderabbit.ai/v1/verify/repositories/{repository_id}/journeys/{cuj_id} \
  --header 'Content-Type: application/json' \
  --header 'x-coderabbitai-api-key: <api-key>' \
  --data '
{
  "expected_list_revision": 123,
  "expected_revision": 123,
  "org_id": "<string>",
  "org_name": "<string>",
  "archive": false
}
'

import requests

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

payload = {
    "expected_list_revision": 123,
    "expected_revision": 123,
    "org_id": "<string>",
    "org_name": "<string>",
    "archive": False
}
headers = {
    "x-coderabbitai-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-coderabbitai-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    expected_list_revision: 123,
    expected_revision: 123,
    org_id: '<string>',
    org_name: '<string>',
    archive: false
  })
};

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

{
  "journey_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 -X PUT "/verify/repositories/$REPOSITORY_ID/journeys/$CUJ_ID" --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 update_verify_journey tool. The connection selects the organization, so the arguments have no org_id or org_name.

{
  "method": "tools/call",
  "params": {
    "name": "update_verify_journey",
    "arguments": {
      "repository_id": "<repository_id>",
      "cuj_id": "<cuj_id>",
      "expected_list_revision": 1,
      "expected_revision": 1
    }
  }
}

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.

cuj_id

string<uuid>

required

Body

application/json

expected_list_revision

integer

required

expected_revision

integer

required

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}$

definition

object

Show child attributes

Response

journey_id

string

required

Basics

Clients

Guides

API reference

Update or archive a user journey with native revision checks

Authorizations

Path Parameters

Body

Response