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

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

Примечание

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

Request

GET

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

Path parameters

Name

Description

orgId

Type: integer

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

userId

Type: string<uint64>

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

Example: ``

Responses

200 OK

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

Body

application/json

{
  "fromName": "example",
  "defaultFrom": "example",
  "signs": [
    {
      "emails": [
        "example"
      ],
      "isDefault": true,
      "text": "example",
      "lang": "example"
    }
  ],
  "signPosition": "bottom"
}

Name	Description
defaultFrom	Type: string Отправлять письма с адреса. Example: `example`
fromName	Type: string Имя отправителя. Example: `example`
signPosition	Type: v1SignPosition Расположение подписи. Расположение подписи. bottom: Внизу всего письма. under: Сразу после ответа. Default: `bottom` Enum: `bottom`, `under`
signs	Type: v1Sign[] Подписи. Example `[ { "emails": [ "example" ], "isDefault": true, "text": "example", "lang": "example" } ]`

v1Sign

Name	Description
emails	Type: string[] Привязать к адресу. Example `[ "example" ]`
isDefault	Type: boolean Является ли подписью по умолчанию.
lang	Type: string Язык подписи. Example: `example`
text	Type: string Текст подписи, поддерживает разметку html, в том числе изображения. Example: `example`

Example

{
  "emails": [
    "example"
  ],
  "isDefault": true,
  "text": "example",
  "lang": "example"
}

v1SignPosition

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

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

Type: string

Default: bottom

Enum: bottom, under

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null

Example

{
  "@type": "example"
}

401 Unauthorized

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

403 Forbidden

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

404 Not Found

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

500 Internal Server Error

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

Была ли статья полезна?

Изменить статус автоматического сбора контактов

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