Adding a Sitemap file

Adds the Sitemap file to Yandex.Webmaster.

  1. Request format
  2. Response format
  3. Response codes

Request format

In the request body, pass the Sitemap file URL and specify the desired data type in the Content-type (application/json or application/xml header):

POST https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/user-added-sitemaps/
Content-type: application/xml

Path parameters

Name Required Type Default value Description
user-id Yes int64 User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /user/ method.
host-id Yes host id The site ID. To get it, use the GET /user/{user-id}/hosts/ method.

Example

{
  "url": "http://example.com"
}
Parameter Description
url URL of the Sitemap file to add.

Response format

Examples

{
  "sitemap_id": "c7-fe:80-c0"
}
Name Required Type Description
sitemap_id Yes string ID of the added Sitemap file.

Response codes

To view the response structure in detail, click the reason.

Code Reason Description
201 CREATED
403

INVALID_USER_ID

The ID of the user who issued the token differs from the one specified in the request. In the examples below, {user_id} shows the correct uid of the OAuth token owner.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
404 HOST_NOT_VERIFIED
Site management rights are not verified.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
409 SITEMAP_ALREADY_ADDED
The Sitemap was already added.
{
  "error_code": "SITEMAP_ALREADY_ADDED",
  "sitemap_id": "c7-fe:80-c0",
  "error_message": "some string"
}