# Search Console Submit Sitemap (`search-console.submit_sitemap`)

Submits a sitemap to Google for a Search Console property (a change to the connected account).

Docs: https://primaryapi.com/docs/api-reference/search-console/submit_sitemap

- Endpoint: `POST https://api.primaryapi.com/v1/run/search-console.submit_sitemap`
- Category: Search & SEO · Platform: `search-console` · Kind: lookup · Status: live
- Price: 1 credit per call. Every call costs the same, including calls that were retried automatically.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=search-console.submit_sitemap`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `siteUrl` | string | yes |  | max 2048 chars | The Search Console property, exactly as search-console.sites lists it: "sc-domain:example.com" for a Domain property, or a URL-prefix property with its trailing slash, e.g. "https://www.example.com/". |
| `sitemapUrl` | string | yes |  | max 2048 chars | Full URL of the sitemap, e.g. "https://www.example.com/sitemap.xml". It must belong to siteUrl (same domain, or under the URL prefix). |
| `connection` | string | no |  | max 200 chars | Which connected account to use when the workspace has several for this provider: the customId you gave it (exact), its connection id ("con_…"), its handle (login, email or @handle) or its name. Optional; prefer the customId or id, which never match two accounts. |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `siteUrl` | string |  |
| `sitemapUrl` | string |  |
| `submitted` | true |  |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/search-console.submit_sitemap" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"siteUrl":"sc-domain:example.com","sitemapUrl":"https://www.example.com/sitemap.xml"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "siteUrl": "sc-domain:example.com",
      "sitemapUrl": "https://www.example.com/sitemap.xml",
      "submitted": true
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: the usual price, even when a call is retried. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=search-console.submit_sitemap`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

WRITE: changes the connected Search Console account. Needs the Manage Search Console capability (search_console_manage), and the Google account needs enough permission on the property itself. The sitemap URL must belong to the property. Submitting the same sitemap again is safe (it is resubmitted, never duplicated). Check processing later with search-console.sitemaps. A property the account cannot manage is a miss with reason no_access and nothing changes.

