Skip to main content

Attachment

Attachment​

KeyTypeDescriptionOptional
metaDataAttachmentMetaMetadata associated with the attachment.
typeAttachmentTypeType of the attachment (e.g., image, video, etc.).

Attachment Type​

KeyValueDescription
IMAGE"image"Image attachment.
VIDEO"video"Video attachment.
DOCUMENT"document"Document attachment.
LINK"link"Link attachment.
CUSTOM"custom"Custom attachment type.
POLL"poll"Poll attachment.
ARTICLE"article"Article attachment.
POST"post"Post attachment.
REPOST"repost"Repost attachment.
GIF"gif"GIF attachment.
REEL"reel"Reel attachment.

Attachment Meta​

KeyTypeDescriptionOptional
entityIdstringIdentifier for the entity related to the attachment.✔️
formatstringFormat of the attachment (e.g., image/jpeg, video/mp4).✔️
namestringName of the attachment.✔️
ogTagsOgTagOpen Graph tags associated with the attachment.✔️
sizenumberSize of the attachment in bytes.✔️
urlstringURL to access the attachment.✔️
durationnumberDuration of the attachment if it’s a video or audio file (in seconds).✔️
coverImageUrlstringURL of the cover image for the attachment (if applicable).✔️
titlestringTitle of the attachment (if it contains a document or media with title).✔️
bodystringBody or content description of the attachment.✔️
pollQuestionstringQuestion text if the attachment is a poll.✔️
expiryTimenumberExpiry timestamp for the poll.✔️
optionsstring[]List of options available for the poll.✔️
multipleSelectStatePollMultipleSelectStatePoll multiple select state (if it's a poll with multiple selections).✔️
pollTypePollTypeType of the poll.✔️
multipleSelectNumbernumberNumber of allowed selections in a multiple-select poll.✔️
isAnonymousbooleanWhether the poll is anonymous.✔️
allowAddOptionbooleanWhether users can add options to the poll.✔️
thumbnailUrlstringURL of the thumbnail for the attachment (if available).✔️
widgetMetaWidgetMeta or nullAny additional metadata related to the attachment.✔️
pageCountnumberNumber of pages (if the attachment is a document).✔️

WidgetMeta​

KeyTypeDescriptionOptional
metaRecord<string, any>Metadata associated with the attachment.