---
metadata:
  - name: generator
    content: Diplodoc Platform v5.55.0
alternate:
  - https://yandex.com/dev/direct/doc/en/sitelinks/add.md
  - https://yandex.com/dev/direct/doc/ru/sitelinks/add.md
  - href: en/sitelinks/add.md
    type: text/markdown
    title: Markdown version
  - href: ../llms.txt
    type: text/markdown
    title: llms.txt
sourcePath: en/ref-v5/sitelinks/add.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/direct/doc/en/llms.txt

# add

Creates sets of sitelinks.

## Learn more

- [How the “add” method works](https://yandex.com/dev/direct/doc/best-practice/modify.html)
- [How to handle errors](https://yandex.com/dev/direct/doc/en/concepts/errors)


## Restrictions {#restrictions}

Maximum of 1000 sets of sitelinks per method call.

If all the fields in the sets are identical, only one set is created.


## Request {#input}

Request structure in JSON format:

```javascript translate=no
{
  "method": "add",
  "params": { /* params */
    "SitelinksSets": [{  /* SitelinksSetAddItem */
      "Sitelinks": [{  /* Sitelink */
        "Title": (string), /* required */
        "Href": (string),
        "Description": (string),
        "TurboPageId": (long)
       }, ... ] /* required */
    }, ... ] /* required */
  }
}
```


#|
||
**Parameter**
|
**Type**
|
**Description**
|
**Required**
||

||
**params structure (for JSON) / AddRequest structure (for SOAP)**
||
||
`SitelinksSets`
|
array of SitelinksSetAddItem
|
The sets of sitelinks to add.
|
Yes
||

||
**SitelinksSetAddItem structure**
||
||
`Sitelinks`
|
array of Sitelink
|
Set of sitelinks. From 1 to 8 items in the array.
|
Yes
||

||
**Sitelink structure**
||
||
`Title`
|
string
|
Text of a sitelink (maximum 30 characters). The maximum total length of texts for sitelinks 1–4 is 66 characters. The maximum total length of texts for sitelinks 5–8 is 66 characters.
|
Yes
||
||
`Href`
|
string
|
The landing page URL where the ad directs users (maximum 1024 characters). It must include the protocol and domain name. May contain [substitution variables](https://yandex.com/support/direct/en/statistics/url-tags.html)[substitution variables](https://yandex.com/support/direct/statistics/url-tags.html).


{% note alert %}

The values of the `{campaign_id}`, `{ad_id}`, `{banner_id}`, and `{phrase_id}` variables will be substituted in the sitelinks only if the same variables are present in the main link for the ad.

{% endnote %}
|
One or both of the `Href` and `TurboPageId` parameters
||
||
`TurboPageId`
|
long
|
ID of the Turbo page.
||
||
`Description`
|
string
|
Sitelink description (maximum 60 characters) for displaying the ad in expanded format.
|
No
||
|# 


## Response {#output}

Response structure in JSON format:

```javascript translate=no
{
  "result": { /* result */
    "AddResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ]
    }, ... ]
  }
}
```


#|
||
**Parameter**
|
**Type**
|
**Description**
||

||
**result structure (for JSON) / AddResponse structure (for SOAP)**
||
||
`AddResults`
|
array of ActionResult
|
Results of adding sets of sitelinks.
||

||
**ActionResult object**
||
||
`Id`
|
long
|
ID of the created set of sitelinks. Returned if there aren't any errors. See the section [Operations on object arrays](https://yandex.com/dev/direct/doc/best-practice/modify.html).
||
||
`Warnings`
|
array of [ExceptionNotification](https://yandex.com/dev/direct/doc/best-practice/modify.html)
|
Warnings that occurred during the operation.
||
||
`Errors`
|
array of [ExceptionNotification](https://yandex.com/dev/direct/doc/best-practice/modify.html)
|
Errors that occurred during the operation.
||
|#