Skip to main content
PATCH
Update a crawl source

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Path Parameters

id
string<uuid>
required

Knowledge base ID.

sourceId
string<uuid>
required

Crawl source ID.

Body

application/json

Any subset of the create fields. Only provided fields are changed.

name
string

Custom display name shown for this source.

Required string length: 1 - 128
Example:

"Developer documentation"

root_url
string
include_paths
string[]
exclude_paths
string[]
max_pages
integer
Required range: 1 <= x <= 500
auto_sync
boolean
sync_interval_hours
integer
Required range: x >= 1

Response

The updated crawl source.

data
object
required