Chats

Delete chat messages by ID(s)

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Chats/deleteChatMessages" target="_blank">Try in sandbox</a><br>Delete messages from chat by given message IDs.

post/api/v2/chats/{id}/messages/delete

Request

Base URL
https://rest.textmagic.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/textmagic/apis/textmagic-api/docs/api/v2/chats/:id/messages/delete/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

Request body

inbound_idsstring

Inbound message IDs to delete. Require when "all" is equal to 0 (false).

sent_idsstring

Sent message IDs to delete. Require when "all" is equal to 0 (false).

calls_idsstring

Calls IDs to delete. Require when "all" is equal to 0 (false).

allboolean

Default is 0 (false). If set to 1, all the entities will be removed.

Example request

{
  "inbound_ids": "1,2,3,4",
  "sent_ids": "1,2,3,4",
  "calls_ids": "1,2,3,4"
}

Response

Request executed with success.

Changes

No recorded changes to this operation across all 4 revisions of this API.