# Редактирование имен отправителей

## Редактирование имени отправителя

<mark style="color:orange;">`PUT`</mark> `https://direct.i-dgtl.ru/api/v1/sender-names/{sender_name_id}`

Метод доступен для SMS-отправителей в статусах AWAITING, REJECTED, APPROVED, а также для VIBER-отправителей в статусе APPROVED.\
Файлы могут быть отправлены только для AWAITING и REJECTED.

#### Path Parameters

| Name                                               | Type    | Description                     |
| -------------------------------------------------- | ------- | ------------------------------- |
| sender\_name\_id<mark style="color:red;">\*</mark> | integer | Идентификатор имени отправителя |

#### Headers

| Name                                            | Type   | Description           |
| ----------------------------------------------- | ------ | --------------------- |
| Authorization<mark style="color:red;">\*</mark> | string | `Basic {TOKEN_2}`     |
| Content-Type<mark style="color:red;">\*</mark>  | string | `multipart/form-data` |

#### Request Body

| Name                                   | Type   | Description                                                                                                       |
| -------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------- |
| name<mark style="color:red;">\*</mark> | string | Имя части содержимого                                                                                             |
| filename                               | string | <p>Имя прикладываемого файла<br>Для <code>name=file</code></p>                                                    |
| senderName                             | string | <p>Новое значение имени отправителя<br>Только для SMS-отправителей в статусе AWAITING</p>                         |
| commonType                             | string | <p>Новое значение типа имени отправителя<br>Только SMS-отправителей в статусе AWAITING</p>                        |
| counteragentName                       | string | <p>Новое значение имени юрлица<br>Только для SMS-отправителей в статусе AWAITING</p>                              |
| counteragentInn                        | string | <p>Новое значение ИНН юрлица<br>Только для SMS-отправителей в статусе AWAITING</p>                                |
| dateFrom                               | string | <p>Новое значение желаемой даты начала действия<br>Только для SMS-отправителей в статусах AWAITING и REJECTED</p> |
| dateTo                                 | string | <p>Дата окончания действия отправителя<br>Только для SMS и VIBER-отправителей в статусе APPROVED</p>              |

::::::{tab-set}

:::::{tab-item} 200

Возвращается объект с отредактированным именем отправителя.

```
{
  "id": 1,
  "senderName": "test",
  "channelType": "SMS",
  "counteragentName": "Контрагент, ООО",
  "counteragentInn": "123451729124",
  "dateFrom": "2020-07-07T21:00:00Z",
  "dateTo": "2020-10-10T00:00:00Z",
  "commonType": "MULTISIGNATURE",
  "brand": "MTS",
  "status": "CLOSED",
  "fee": 0,
  "managerComment": "комментарий менеджера",
  "rejectedAt": "2020-07-09T16:55:01Z"
}
```
:::::


:::::{tab-item} 401

Использование невалидного токена / отсутствие заголовка авторизации.

::::{tab-set}

:::{tab-item} 4012

```
{
    "error": {
        "code": 4012,
        "msg": "Bad credentials"
    }
}
```
:::


:::{tab-item} 4010

```
{
    "error": {
        "code": 4010,
        "msg": "Not Authenticated"
    }
}
```
:::

::::

:::::


:::::{tab-item} 403

Использование неподходящего токена.

```
{
    "error": {
        "code": 4030,
        "msg": "Access Denied"
    }
}
```
:::::


:::::{tab-item} 422

Невалидные параметры в теле запроса либо несоответствующий статус имени отправителя; ниже приведены несколько примеров ответа.

```
{
    "error": {
        "code": 4220,
        "msg": "Changing sender name is not allowed now"
    }
}
-----------------------------------------------------------------------------
{
    "error": {
        "code": 4220,
        "msg": "Date from isn't greater than now"
    }
}
```
:::::

::::::


Возможные варианты перечислений:

| Параметр   | Варианты                                                         |
| ---------- | ---------------------------------------------------------------- |
| commonType | [Типы имен отправителей](../extra/references/#sender-name-types) |

## Пример запроса <a href="#example" id="example"></a>

Редактирование наименования юрлица, ИНН и даты начала действия с прикреплением нового файла

::::::{tab-set}

:::::{tab-item} JSON

```
PUT https://direct.i-dgtl/ru/api/v1/sender-names/150
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: multipart/form-data; boundary=--part
--part
Content-Disposition: form-data; name="file1"; filename="document1.pdf"
< ./path/new_document.pdf
--part
Content-Disposition: form-data; name="body"
Content-Type: application/json
{
  "dateFrom": "2020-10-07T21:00:00Z",
  "counteragentName": "Новый контрагент, ООО",
  "counteragentInn": "123451729124"
}
```
:::::


:::::{tab-item} cURL

```
curl -X PUT 'https://direct.i-dgtl.ru/api/v1/sender-names/150' \
-H 'Content-Type: multipart/form-data;boundary=--part' \
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
-F 'body={"dateFrom":"2020-10-07T21:00:00Z","counteragentName":"Новый контрагент, ООО","counteragentInn":"123451729124"}' \
-F 'file1=@path/new_document.pdf'
```
:::::

::::::