DeleteInstanceAccount#
Метод предназначен для удаления инстанса на аккаунте партнёра.
Запрос#
Для удаления инстанса аккаунта от имени партнёра требуется выполнить POST запрос по адресу:
POST
{{partnerApiUrl}}/partner/deleteInstanceAccount/{{partnerToken}}
Параметр
partnerApiUrlможно увидеть в личном кабинете.Получение параметра запроса
partnerTokenпроисходит через техподдержку Green API с запросом получить API-ключ партнёра.
Параметры запроса#
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
idInstance | integer | обязательный параметр | Идентификатор инстанса аккаунта. Размер integer равен int64. Значения лежат в диапазоне от 1 до 10 разрядов |
Пример тела запроса#
{
"idInstance": 1101000000
}
Ответ#
Поля ответа#
| Поле | Тип | Описание |
|---|---|---|
deleteInstanceAccount | boolean | флаг удаления инстанса аккаунта |
Пример тела ответа#
В случае успеха, в ответ на запрос, отдается JSON строка следующего вида с HTTP статусом 200:
{
"deleteInstanceAccount": true
}
Ошибки DeleteInstanceAccount#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
| Код HTTP | Идентификатор ошибки | Описание |
|---|---|---|
| 200 | "code": 404,"description": "Not found" | Инстанс не существует или уже был удалён |
| 200 | "code": 401,"description": "Unauthorized" | Проблема с авторизацией, проверьте корректность указания partnerToken |