Authentication
Send an API key as a bearer token. The key must carry the sites.panel_access permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/sitemap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
⛔ **`202`, and the returned state describes a job that has STARTED.** A crawler walks the whole site and may take minutes; the sitemap does not exist when this returns. Poll `getSiteSitemap` until `running` is false. Answering `200` here would be the status-code equivalent of telling the customer their sitemap is ready. `upload` writes `sitemap.xml` into the webspace, overwriting any existing file. Requires `sites.panel_access`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
frequency | string<always, hourly, daily, weekly, monthly, never, yearly> | No | The `changefreq` written into the generated XML. A guideline to search engines, not a guarantee. |
upload | boolean | No | Overwrite `sitemap.xml` in the webspace when the crawl finishes. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
ever_run | boolean | Yes | Has a crawl ever been run for this site? |
running | boolean | Yes | Is a crawl in progress? ⛔ Computed as *not in a terminal state*, so a state we have never seen reads as still working rather than as finished. |
state | string | Yes | The vendor's own job state, verbatim. Empty when none has run. |
created_at | string | Yes | When the most recent crawl started. Empty when none has run. |
output | string | Yes | The crawler's own output, if it produced any. |
upload | boolean | Yes | Whether the crawl writes `sitemap.xml` into the webspace. |
frequencies | string[] | Yes | The change frequencies this site's crawler accepts. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503