GUgupshup
Knowledge — Websites

Add website

A url without a scheme is accepted and normalised to https://.

post/partner/app/{appId}/bizai/agent_config/websites

Request

  • Base URL
    https://partner.gupshup.io
  • URL
    https://partner.gupshup.io/partner/app/{appId}/bizai/agent_config/websites
  • Auth
    API key in header Authorization

Request body

urlstring uri required
included_sub_domainsstring[]
included_url_patternsstring[]
excluded_sub_domainsstring[]
excluded_url_patternsstring[]
single_urlsstring[]

Response

Website added; crawling starts asynchronously.

urlstring uri required
included_sub_domainsstring[]
included_url_patternsstring[]
excluded_sub_domainsstring[]
excluded_url_patternsstring[]
single_urlsstring[]
idstring

Meta resource id.

crawl_status'not_started' | 'pending' | 'in_progress' | 'completed' | 'completed_no_data' | 'failed'
crawl_errorstring
pages_crawledinteger
last_crawled_atinteger
created_atinteger

Example response

{
  "id": "pfbid0GNkExampleExampleExample"
}

Changes

No recorded changes to this operation across all 1 revision of this API.