Delete

API Reference

Contacts

Bulk

Delete multiple contacts

contacts.bulk.delete(BulkDeleteParams**kwargs) -> BulkDeleteResponse

delete/api/v2/contacts

Delete multiple contacts by their IDs

ParametersExpand Collapse

contact_ids: SequenceNotStr[str]

Array of phone numbers in E.164 format to delete

ReturnsExpand Collapse

class BulkDeleteResponse: …

amount: Optional[int]

Number of contacts deleted

status: Optional[str]

Delete multiple contacts

python

• http
• typescript
• python

from sendblue_api import SendblueAPI

client = SendblueAPI(
    api_key="My API Key",
    api_secret="My API Secret",
)
bulk = client.contacts.bulk.delete(
    contact_ids=["+1234567890", "+0987654321"],
)
print(bulk.amount)

200 example

{
  "amount": 0,
  "status": "OK"
}

Returns Examples

200 example

{
  "amount": 0,
  "status": "OK"
}