Изменить данные общего ящика
Меняет информацию (имя и описание) общего ящика.
В запросе к API направляется поле resourceId — идентификатор общего почтового ящика, информацию о котором надо изменить.
Примечание
Чтобы выполнить запрос, приложению требуется разрешение на управление правами доступа к почтовым ящикам. Убедитесь, что вы включили его при настройке приложения на OAuth-сервере Яндекса.
Request
PUT
https://api360.yandex.net/admin/v1/org/{orgId}/mailboxes/shared/{resourceId}
Path parameters
|
Name |
Description |
|
orgId |
Type: integer Идентификатор организации. |
|
resourceId |
Type: string<uint64> Идентификатор общего ящика. Example: `` |
Body
application/json
{
"name": "example",
"description": "example"
}
|
Name |
Description |
|
description |
Type: string Описание. Example: |
|
name |
Type: string Имя. Example: |
Responses
200 OK
200 OK — запрос выполнен успешно.
Body
application/json
{
"resourceId": "example"
}
|
Name |
Description |
|
resourceId |
Type: string<uint64> Идентификатор почтового ящика. Example: |
400 Bad Request
400 Bad Request — некорректный запрос.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
protobufAny
|
Name |
Description |
|
@type |
Type: string Example: |
|
[additional] |
Type: unknown Example: |
Example
{
"@type": "example"
}
401 Unauthorized
401 Unauthorized — пользователь не авторизован.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
403 Forbidden
403 Forbidden — у пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
404 Not Found
404 Not Found — запрашиваемый ресурс не найден.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |
500 Internal Server Error
500 Internal Server Error — внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
Body
application/json
{
"code": 0,
"message": "example",
"details": [
{
"@type": "example"
}
]
}
|
Name |
Description |
|
code |
Type: integer Код ошибки. |
|
details |
Type: protobufAny[] Дополнительные сведения об ошибке. Example |
|
message |
Type: string Описание ошибки. Example: |