Перейти к содержанию

DeleteInstanceAccount#

Тест Postman

Метод предназначен для удаления инстанса на аккаунте партнёра.

Запрос#

Для удаления инстанса аккаунта от имени партнёра требуется выполнить 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
}

В случае неудачи, отдается ответ с HTTP статусом 200, в теле ответа отдается JSON строка с кодом и описанием ошибки:

{
    "code": 401,
    "description": "Unauthorized"
}

Ошибки DeleteInstanceAccount#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки