Message
Delete Messages (bulk)
Deletes a set of messages
Note: Deletion is only from Zoko database and will not affect the actual message(s) at the customer's client application.
DELETE
/
message
/
batch
Authorization
Body
curl --request DELETE \
--url https://chat.zoko.io/v2/message/batch \
--header 'Content-Type: application/json' \
--header 'apikey: <apikey>' \
--data '{
"messages": [
"<string>"
]
}'
{
"deleted": 43,
"failed": 7,
"messages": [
{
"description": "message {id} deleted",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "message deleted"
}
]
}
Authorizations
apikey
string
headerrequiredAuthentication is done via apikey
provided for your account
Include the following in your request header
apikey: "your_apikey_here"
Body
application/json
messages
string[]
requiredIDs of messages to be deleted
Response
200 - application/json
deleted
integer
number of messages deleted
failed
integer
number of messages failed
messages
object[]
message deletion details
curl --request DELETE \
--url https://chat.zoko.io/v2/message/batch \
--header 'Content-Type: application/json' \
--header 'apikey: <apikey>' \
--data '{
"messages": [
"<string>"
]
}'
{
"deleted": 43,
"failed": 7,
"messages": [
{
"description": "message {id} deleted",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "message deleted"
}
]
}