post
https://partner.gupshup.io/partner/app//bizai/agent_config/websites
A url without a scheme is accepted and normalised to https://.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Request parameters
| Parameter | Type | Required | In | Description |
|---|---|---|---|---|
Authorization | string | Yes | Header | Partner app token, sent raw. Bearer <token> is also accepted. |
Content-Type | string | Yes | Header | application/json |
appId | string (uuid) | Yes | Path | Partner Portal app id. Stands in for Meta's entity_id. |
url | string | Yes | Body | Site root to crawl. A URL without a scheme is normalised to https://. |
included_sub_domains | array of string | No | Body | Sub-domains to crawl in addition to the root. |
included_url_patterns | array of string | No | Body | Only crawl paths matching these patterns. |
excluded_sub_domains | array of string | No | Body | Sub-domains to skip. |
excluded_url_patterns | array of string | No | Body | Paths to skip. |
single_urls | array of string | No | Body | Individual pages to add without crawling. |
Example request
curl --location --request POST 'https://partner.gupshup.io/partner/app/<appId>/bizai/agent_config/websites' \
--header 'Authorization: <PARTNER_APP_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com",
"included_sub_domains": [
"support.example.com"
],
"included_url_patterns": [
"/help/",
"/faq/"
],
"excluded_sub_domains": [
"staging.example.com"
],
"excluded_url_patterns": [
"/admin/",
"/private/"
],
"single_urls": [
"https://example.com/pricing"
]
}'Response parameters — 201
201| Parameter | Type | Description |
|---|---|---|
url | string | Site root to crawl. A URL without a scheme is normalised to https://. |
included_sub_domains | array of string | Sub-domains to crawl in addition to the root. |
included_url_patterns | array of string | Only crawl paths matching these patterns. |
excluded_sub_domains | array of string | Sub-domains to skip. |
excluded_url_patterns | array of string | Paths to skip. |
single_urls | array of string | Individual pages to add without crawling. |
id | string | Resource id. Meta pfbid… id. |
crawl_status | string | One of: not_started, pending, in_progress, completed, completed_no_data, failed. |
crawl_error | string | Why the crawl failed, when crawl_status is failed. |
pages_crawled | integer | Number of pages crawled so far. |
last_crawled_at | integer | Last crawl time, Unix seconds. |
created_at | integer | Creation time, Unix seconds. |
Example response — 201 Created
201 Created{
"id": "pfbid0WebsiteExampleId",
"url": "https://example.com",
"included_sub_domains": ["support.example.com"],
"included_url_patterns": ["/help/", "/faq/"],
"excluded_sub_domains": ["staging.example.com"],
"excluded_url_patterns": ["/admin/", "/private/"],
"single_urls": ["https://example.com/pricing"],
"crawl_status": "not_started",
"pages_crawled": 1,
"last_crawled_at": 1789630852,
"created_at": 1789630852
}Error responses
400 Bad Request — The app is not live, or WASS does not consider it live.
{
"message": "App is not live.",
"status": "error"
}400 Bad Request — The app has no phone number attached. Checked before the live check.
{
"message": "Phone id not found for the given App",
"status": "error"
}401 Unauthorized — Authorization is missing or invalid, belongs to another app, or appId is unknown or not a UUID.
{
"status": "error",
"message": "Unauthorised access to the resource. Please review request parameters and headers and retry"
}405 Method Not Allowed — Any method other than GET, POST, PUT or DELETE, e.g. PATCH.
{
"status": "error",
"message": "Request method 'PATCH' is not supported"
}429 Too Many Requests — More than 30 /bizai/** requests in 60 seconds for this app. The 31st is rejected.
{
"status": "error",
"message": "Too Many Requests"
}Per-app rate limit exceeded. Retry after the 60-second window.