Skip to main content
POST
Deleting instances in bulk

Overview

Method used to delete several instances linked to your account in a single request. To delete a single instance, use Deleting an instance.
To use Partner endpoints, provide the Partner Token in the Authorization field using the following format: Bearer <Partner-Token>It is not necessary to send the Client-Token in these requests.
Send at most 100 instances per request. For larger volumes, split the operation into several calls.
Each instance in the list is evaluated individually. A rejected instance does not prevent the others from being deleted: the response reports the outcome of each one.

Eligibility rules

An instance is only deleted when it meets all of the conditions below:
  • It is disconnected from WhatsApp and from the phone.
  • Its subscription is canceled. Paid instances, pending ones, ones with a pending bank slip, ones in the cancellation process, or ones in payment retry are not eligible.
  • It is not in trial. A trial must expire naturally or be canceled first.
  • The 40-day grace period counted from the subscription cancellation date has already passed.

Attributes

string
required
Partner token in the Bearer <Partner-Token> format

Required

array
required
List of instances to be deleted. Maximum of 100 per request.

Request Body


Response

200

The results field has one entry per instance sent, in the same order as the request.

Rejection reasons

Each rejected item has a type that identifies the rule that blocked the deletion.

400

The instance list was empty or above the limit of 100 per request.

401

The Authorization header was not sent or the Partner Token is invalid.

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.