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

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

<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>              |

{% tabs %}
{% tab title="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"
}
```

{% endtab %}

{% tab title="401" %}
Использование невалидного токена / отсутствие заголовка авторизации.

{% tabs %}
{% tab title="4012" %}

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

{% endtab %}

{% tab title="4010" %}

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

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="403" %}
Использование неподходящего токена.

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

{% endtab %}

{% tab title="422" %}
Невалидные параметры в теле запроса либо несоответствующий статус имени отправителя; ниже приведены несколько примеров ответа.

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

{% endtab %}
{% endtabs %}

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

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

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

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

{% tabs %}
{% tab title="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"
}
```

{% endtab %}

{% tab title="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'
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api.docs.direct.i-dgtl.ru/sender-names/put.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
