sitelinks.group.set
Assign sitelinks to provided groups.
If you want to remove any previous assignment, you can send empty array as sitelinkIds
attribute value.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| array |
groups ( |
|
| struct |
{ |
|
| array |
sitelinkIds ( |
To clean sitelinks send that parameter as empty array
|
|
int
|
|
|
(optional) Sitelink ID
|
|
) |
|
|
|
} |
|
|
|
) |
|
|
Response
| struct |
{ |
|
| int |
status |
Status code (see bellow)
|
| string |
statusMessage |
Status code description
|
| string |
session |
(optional) Refreshed session
|
| array |
diagnostics ( |
(optional) Various diagnostics(warnings, errors, other information)
|
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK206: Partially OK301: User is serviced400: Bad arguments401: Invalid session403: Access Denied404: Not found406: Bad values of attributes413: Too many items requested.429: Too many requests. Has to wait.500: Server Error.409: Conflict
Diagnostics:
List of all possible diagnostics:
group_access_deniedsitelink_access_deniedsitelink_deleted: Updates to the deleted sitelink are not allowed.sitelink_duplicityuser_access_denied
