Complete site migration project

POST/v1/api/sites/{site_id}/migrations/projects/{migration_id}/complete

Mark the site's migration project complete. Owner or admin.

Scope: sites:write
Token: OAuth access token only
Role: Owner or admin
MCP tool: complete_migration_project · preview: MCP write tools are in preview; What scopes, tokens and roles mean →

Request

curl -X POST "https://api.crawle.io/v1/api/sites/11111111-1111-1111-1111-111111111111/migrations/projects/11111111-1111-1111-1111-111111111111/complete" \
  -H "Authorization: Bearer $CRAWLE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

const response = await fetch("https://api.crawle.io/v1/api/sites/11111111-1111-1111-1111-111111111111/migrations/projects/11111111-1111-1111-1111-111111111111/complete", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CRAWLE_ACCESS_TOKEN}`,
    "Idempotency-Key": crypto.randomUUID(),
  },
});
const data = await response.json();

import os
import uuid

import requests

response = requests.request(
    "POST",
    "https://api.crawle.io/v1/api/sites/11111111-1111-1111-1111-111111111111/migrations/projects/11111111-1111-1111-1111-111111111111/complete",
    headers={
        "Authorization": f"Bearer {os.environ['CRAWLE_ACCESS_TOKEN']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
)
data = response.json()

$CRAWLE_ACCESS_TOKEN: is an OAuth access token from your integration's sign-in.
Idempotency-Key: is a new unique value for each new request.

Response 200JSON

{
  "avg_path_similarity": 1.5,
  "client_id": "example",
  "committed": true,
  "completed_at": "2026-01-01T09:00:00Z",
  "confidence": 1.5,
  "confirmed_at": "2026-01-01T09:00:00Z",
  "crawler_candidate_id": 1,
  "created_at": "2026-01-01T09:00:00Z",
  "details": {},
  "effect_results": {},
  "evidence_status": "current",
  "grace_days": 1,
  "grace_ends_at": "2026-01-01T09:00:00Z",
  "grace_started_at": "2026-01-01T09:00:00Z",
  "id": "example",
  "migration_type": "example",
  "receipt_id": "example",
  "redirect_count": 1,
  "redirect_coverage": 1.5,
  "redirect_url_denominator": 1,
  "rejected_at": "2026-01-01T09:00:00Z",
  "replayed": false,
  "source_domain": "example.com",
  "source_website_id": "example",
  "status": "example",
  "target_domain": "example.com",
  "target_verified": true,
  "target_website_id": "example",
  "updated_at": "2026-01-01T09:00:00Z"
}

Example generated from the API contract.

Parameters

site_idpath · string (uuid)required
migration_idpath · string (uuid)required
Idempotency-Keyheader · stringrequired: 1–180 characters

Response 200

avg_path_similaritynumberrequired
client_idstringrequired
completed_atstring (date-time) or nullrequired
confidencenumberrequired
confirmed_atstring (date-time) or nullrequired
crawler_candidate_idinteger or nullrequired
created_atstring (date-time)required
detailsobject or nullrequired
effect_resultsobjectrequired
evidence_statusenum or nullrequired: one of "current", "stale"
grace_ends_atstring (date-time) or nullrequired
grace_started_atstring (date-time) or nullrequired
idstringrequired
migration_typestringrequired
receipt_idstringrequired
redirect_countintegerrequired
redirect_coveragenumber or nullrequired
redirect_url_denominatorinteger or nullrequired
rejected_atstring (date-time) or nullrequired
source_domainstringrequired
source_website_idstringrequired
statusstringrequired
target_domainstringrequired
target_verifiedboolean or nullrequired
target_website_idstring or nullrequired
updated_atstring (date-time)required
committedboolean: default true
grace_daysinteger or null: 1–90
replayedboolean: default false

Errors

401
When
Missing, invalid, or expired token.
403
When
The token has none of the accepted scopes (sites:write).
403
When
Called with an API key. This endpoint needs an OAuth access token.
403
When
The person is not a workspace owner or admin.
422
When
The request did not match the schema. detail lists each problem.
429
When
Rate limited. Wait for Retry-After seconds.

Complete site migration project: errors
Status	When
401	Missing, invalid, or expired token.
403	The token has none of the accepted scopes (`sites:write`).
403	Called with an API key. This endpoint needs an OAuth access token.
403	The person is not a workspace owner or admin.
422	The request did not match the schema. `detail` lists each problem.
429	Rate limited. Wait for `Retry-After` seconds.

All errors and what to do →

Generated from the API contract at 7e7039b0b, synced October 30, 2026.