Apply bulk settings

POST/v1/api/bulk-settings/apply

Apply crawl settings to selected sites using OAuth editor access.

Scope: settings:write
Token: OAuth access token only
Role: Editor, owner or admin
MCP tool: apply_bulk_settings · preview: MCP write tools are in preview; What scopes, tokens and roles mean →

Request

curl -X POST "https://api.crawle.io/v1/api/bulk-settings/apply" \
  -H "Authorization: Bearer $CRAWLE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch("https://api.crawle.io/v1/api/bulk-settings/apply", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CRAWLE_ACCESS_TOKEN}`,
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const data = await response.json();

import os
import uuid

import requests

response = requests.request(
    "POST",
    "https://api.crawle.io/v1/api/bulk-settings/apply",
    headers={
        "Authorization": f"Bearer {os.environ['CRAWLE_ACCESS_TOKEN']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={},
)
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 200: a JSON object. Its fields are not described in the API contract yet, so no example is shown.

Parameters

Idempotency-Keyheader · stringrequired: 1–180 characters

Request body

client_group_idsarray of string (uuid) or null: up to 100 items
overwriteboolean: default false
settingsobject
site_idsarray of string (uuid) or null: up to 500 items
tag_idsarray of string (uuid) or null: up to 100 items

Response 200

Returns a JSON object. Its fields are not described in the API contract yet.

Errors

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

Apply bulk settings: errors
Status	When
401	Missing, invalid, or expired token.
403	The token has none of the accepted scopes (`settings:write`).
403	Called with an API key. This endpoint needs an OAuth access token.
403	The person's workspace role is below editor.
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.