DeleteInstanceAccount#
The method is aimed for deleting an instance of the partners's account.
Request#
To delete an instance on the partner's part you have to execute a POST request at:
POST
{{partnerApiUrl}}/partner/deleteInstanceAccount/{{partnerToken}}
For
partnerApiUrl
request parameter, you can find it in your console.For
partnerToken
request parameter please contact Green API support@green-api.com with a request to get a partnership API-token.
Request parameters#
Parameter | Type | Mandatory | Description |
---|---|---|---|
idInstance | integer | mandatory parameter | Instance Id. The size of the integer is int64. Values range include from 1 to 10 digits |
Request body example#
{
"idInstance": 1101000000
}
Response#
Response parameters#
Parameter | Type | Description |
---|---|---|
deleteInstanceAccount | boolean | account instance deletion flag |
Response body example#
If successful, in response to the request, you get a JSON string with HTTP 200 status of the below form:
{
"deleteInstanceAccount": true
}
In case of failure, you get a response with HTTP 200 status, a JSON string with a code and description of the error is returned in the response body:
{
"code": 401,
"description": "Unauthorized"
}
DeleteInstanceAccount errors#
For a list of errors common to all methods, refer to Common errors section