DeleteInstanceAccount#

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

Запрос#

Для удаления инстанса аккаунта от имени партнёра требуется выполнить POST запрос по адресу:

POST

{{partnerApiUrl}}/partner/deleteInstanceAccount/{{partnerToken}}

Параметр partnerApiUrl можно увидеть в личном кабинете.

Получение параметра запроса partnerToken происходит через техподдержку GREEN-API с запросом получить API-ключ партнёра.

Параметры запроса#

Параметр	Тип	Обязательный	Описание
`idInstance`	integer	обязательный параметр	Идентификатор инстанса аккаунта. Значение типа uint64, 10 разрядов

Пример тела запроса#

{
    "idInstance": 3100000000
}

Ответ#

Поля ответа#

Поле	Тип	Описание
`deleteInstanceAccount`	boolean	флаг удаления инстанса аккаунта

Пример тела ответа#

В случае успеха, в ответ на запрос, отдается JSON строка следующего вида с HTTP статусом 200:

{
    "deleteInstanceAccount": true
}

Ошибки DeleteInstanceAccount#

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

Код HTTP	Идентификатор ошибки	Описание
200	`"code": 404,` `"description": "Not found"`	Инстанс не существует или уже был удалён
200	`"code": 401,` `"description": "Unauthorized"`	Проблема с авторизацией, проверьте корректность указания `partnerToken`

Примеры кода#

PythoncURLJava - Unirest

import requests

url = "https://api.green-api.com/partner/deleteInstanceAccount/{{partnerToken}}"

payload = {
 "idInstance": 3100000000
  }
headers = {
 'Content-Type': 'application/json'
}

response = requests.post(url, json=payload)

print(response.text.encode('utf8'))

  curl --location --globoff 'https://api.green-api.com/partner/deleteInstanceAccount/{{partnerToken}}' \
--header 'Content-Type: application/json' \
--data '{
    "idInstance": 3100000000 
}
'

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://api.green-api.com/partner/deleteInstanceAccount/{{partnerToken}}")
 .header("Content-Type", "application/json")
 .body("{\r\n    \"idInstance\": 3100000000 \r\n}\r\n")
 .asString();