Sign in

v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB
Message

Delete Message

Delete an existing message

delete/message

Query parameters

selectstring

Select columns to return

idstring required

Message ID

created_atstring

Message creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

conversation_idstring

Conversation ID

is_inboundstring

Is the message inbound?

subjectstring

Subject of message

author_idstring

Author ID

contentstring

Content of message

raw_contentstring

Raw content of message

statusstring

Status of message

attachment_countstring

Attachment count of message

reply_to_message_idstring

Reply to message ID

external_filesstring

External files of message

external_idstring

External ID

template_idstring

Template ID

review_channel_idstring

Review Channel ID

author_typestring

Author type of message

forwardedstring

Is message forwarded?

forwarded_message_textstring

Forwarded Message text

send_afterstring

Message send after

footerstring

Message footer

sendout_idstring

Sendout ID

campaign_idstring

Campaign ID

sent_atstring

Message sent at

timestampstring

Timestamp of message

locationstring

Coordinates that are shared via chat

location_metadatastring

Location metadata of message

contactsstring

Contacts of message

filesstring

Files shared with the message

header_media_filenamestring

Header media filename of message

Response

The updated Message object

idstring uuid

Message ID

created_atstring timestamp with time zone

Message creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

conversation_idstring uuid

Conversation ID

is_inboundboolean

Is the message inbound?

subjectstring text nullable

Subject of message

author_idstring uuid nullable

Author ID

contentobject nullable

Content of message

raw_contentstring text nullable

Raw content of message

status'sent' | 'sending_error' | 'bounce_error' | 'submission_error' | 'submitted' | 'sending' | 'read' | 'draft' | 'scheduled' | 'interacted' | 'answered' public.recipient_status nullable

Status of message

attachment_countinteger nullable

Attachment count of message

reply_to_message_idstring uuid nullable

Reply to message ID

external_filesobject nullable

External files of message

external_idstring text nullable

External ID

template_idstring uuid nullable

Template ID

review_channel_idstring uuid nullable

Review Channel ID

author_type'employee' | 'bot' | 'external' public.author_type nullable

Author type of message

forwardedboolean

Is message forwarded?

forwarded_message_textstring text nullable

Forwarded Message text

send_afterstring timestamp with time zone nullable

Message send after

footerstring text nullable

Message footer

sendout_idstring uuid nullable

Sendout ID

campaign_idstring uuid nullable

Campaign ID

sent_atstring timestamp with time zone nullable

Message sent at

timestampstring timestamp with time zone nullable

Timestamp of message

locationstring extensions.geography(Point,4326) nullable

Coordinates that are shared via chat

location_metadataobject nullable

Location metadata of message

contactsobject nullable

Contacts of message

filesobject nullable

Files shared with the message

header_media_filenamestring text nullable

Header media filename of message