Изменить адреса электронной почты

Изменяет электронные адреса внешнего контакта.

Полностью заменяет список текущих адресов. Новый список не может быть пустым. В новом списке должен быть ровно один адрес с флагом main=true — основной электронный адрес. На него будут отправляться письма, если выбрать контакт в качестве получателя.

Request

PUT

https://api360.yandex.net/directory/v1/org/{orgId}/external_contacts/{contactId}/emails

Path parameters

Name

Description

contactId

Type: string

Идентификатор внешнего контакта.

Example: ``

orgId

Type: integer

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

Body

application/json
{
  "emails": [
    {
      "email": "example",
      "type": "example",
      "main": true
    }
  ]
}

Name

Description

emails

Type: v1ExternalContactEmail[]

Электронные адреса.

Example
[
  {
    "email": "example",
    "type": "example",
    "main": true
  }
]

v1ExternalContactEmail

Name

Description

email

Type: string

Электронный адрес.

Example: example

main

Type: boolean

Признак основного электронного адреса:

  • true — основной (обязательно должен быть ровно у одного адреса);
  • false — дополнительный.

type

Type: string

Тип электронного адреса. Возможные значения:

  • work — для рабочей почты;
  • для личной почты пользователя оставьте поле незаполненным.

Example: example

Example
{
  "email": "example",
  "type": "example",
  "main": true
}

Responses

200 OK

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

Body

application/json
{
  "id": "example"
}

Name

Description

id

Type: string

Идентификатор внешнего контакта.

Example: example

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

No longer supported, please use an alternative and newer version.