Просмотреть основной адрес и подписи

Метод позволяет просмотреть почтовый адрес, с которого отправляются письма по умолчанию, и настройки подписей сотрудника.

Примечание

Чтобы выполнить запрос, приложению требуется разрешение на чтение настроек почты пользователя. Убедитесь, что вы включили его при настройке приложения на OAuth-сервере Яндекса.

Request

GET

https://api360.yandex.net/admin/v1/org/{orgId}/mail/users/{userId}/settings/sender_info

Path parameters

Name

Description

orgId*

Type: integer<int64>

Идентификатор организации.

userId*

Type: string<uint64>

Идентификатор пользователя.

Responses

200 OK

Запрос успешно выполнен.

Body

application/json
{
    "fromName": "string",
    "defaultFrom": "string",
    "signs": [
        {
            "emails": [
                "string"
            ],
            "isDefault": false,
            "text": "string",
            "lang": "string"
        }
    ],
    "signPosition": "bottom"
}

Name

Description

defaultFrom

Type: string

Отправлять письма с адреса.

fromName

Type: string

Имя отправителя.

signPosition

Type: v1SignPosition

Расположение подписи.

Default: bottom

Enum: bottom, under

signs

Type: v1Sign[]

Подписи.

v1SignPosition

Расположение подписи.

  • bottom: Внизу всего письма.
  • under: Сразу после ответа.

Type

Description

v1SignPosition

Default: bottom

Enum: bottom, under

v1Sign

Name

Description

emails

Type: string[]

Привязать к адресу.

isDefault

Type: boolean

Является ли подписью по умолчанию.

lang

Type: string

Язык подписи.

text

Type: string

Текст подписи, поддерживает разметку html, в том числе изображения.

401 Unauthorized

Пользователь не авторизован.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

403 Forbidden

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.
Предыдущая
Изменить статус автоматического сбора контактов
Следующая
Изменить основной адрес и подписи