Skip to content
Linq Copy agent prompt

Polls

Messages are individual communications within a chat thread.

Messages can include text, media attachments, rich link previews, special effects (like confetti or fireworks), and reactions. All messages are associated with a specific chat and sent from a phone number you own.

Messages support delivery status tracking, read receipts, and editing capabilities.

Send a URL as a link part to deliver it with a rich preview card showing the page’s title, description, and image (when available). A link part must be the only part in the message — it cannot be combined with text or media parts. To send a URL without a preview card, include it in a text part instead.

Limitations:

  • A link part cannot be combined with other parts in the same message.
  • Maximum URL length: 2,048 characters.

App Clips

An app_clip part sends a registered App Clip — not only Linq’s Apple Pay checkout, but any partner’s own App Clip. Like a link part it must be the only part in the message, and it is iMessage only — it never downgrades to SMS or RCS. The payment-checkout use of this part is covered in the Payments section.

Ephemeral Messages (Privacy Tier)

For regulated or sensitive conversations, opt in to the ephemeral messages tier by contacting your Linq support contact. When enabled, every message on the covered phone numbers is given a retention window configured for your account. After that window, the message’s text, formatting, and attachment references are no longer retrievable through the API — see the Attachments row below for how the attachment media itself is handled. Metadata about the message is retained: message identifiers, timestamps, phone numbers, and delivery state. Metadata retention is not bounded by this window. Bounded operational copies, such as backups and delivery queues, expire on their own separate schedules. There is no per-message flag; ephemerality is applied automatically based on your configuration.

The window can be set anywhere from 60 minutes to 24 hours, and defaults to 24 hours. Ask your Linq support contact to configure a shorter window; it cannot be changed through the API.

You can request it at two scopes:

ScopeEffect
Partner-wideEvery outbound and inbound message on every phone number under your account has its content removed from the API surface after your configured window. Metadata is retained.
Per phone numberOnly the specified phone numbers have message content removed from the API surface this way. The rest follow the standard message-retention policy.

Behavioral differences vs the standard default:

AspectStandardEphemeral
RetentionRetained per the standard message-retention policyHard backstop: your configured window (60 minutes – 24 hours, default 24 hours) from when the message is created
After expiryMessage stays retrievableMessage content is no longer retrievable — GET /v3/messages/{messageId} returns 404 and it no longer appears in GET /v3/chats/{chatId}/messages
Content on expiryN/AText, formatting, and attachment references are removed from the API surface, not blanked out in place. Metadata (identifiers, timestamps, phone numbers, delivery state) is retained; its retention is not bounded by this window
AttachmentsRetainedMedia sent on the ephemeral attachments tier is removed on its own storage backstop — within roughly 24–48 hours of upload — independently of the message window, so it can outlast a window shorter than a day. Attachments on the persistent tier (including pre-uploads via POST /v3/attachments) are kept until you DELETE them
Cross-partner isolationEnforcedEnforced

How the retention window works:

  • The window runs from message creation (created_at). It is configured for your account (60 minutes – 24 hours, default 24 hours) and cannot be set per message.
  • Attachment media follows its own storage backstop rather than the message window — see the Attachments row above.
  • Expiry is delivery-independent — the clock starts when the message is created, not when it is delivered or read.
  • Deletion happens shortly after the window, not exactly at it. A background sweep runs every ~5 minutes, so a message typically stops being retrievable within about 5 minutes of its expiry, and longer while a backlog is being worked through. Treat the window as the guaranteed minimum retention, never as an exact deletion time or an upper bound.

What you observe:

  • No expiry timestamp is exposed. API responses and webhook payloads do not include the deletion time, and they do not report your configured window either — so if you are on a window shorter than 24 hours you cannot derive a message’s expiry from the API today. Track the window you agreed with your Linq support contact and compute created_at + window yourself.
  • No deletion webhook is sent. There is no message.deleted event — a message simply stops being retrievable once its window passes.
  • The attachment backstop is separate from the message window. API retrievability (the 404 behavior above) ends at your configured window. Ephemeral-tier media objects are removed on their own storage backstop — within roughly 24–48 hours of upload — which is independent of the message window and can outlast a window shorter than a day. Removal of the corresponding entries from the sending device happens asynchronously and can complete after the backstop.
  • Delivery is unaffected. Ephemeral messages send, deliver, and fire the usual message.sent / message.received and status webhooks exactly like standard messages. Only retention changes.

When to choose ephemeral:

  • You have a compliance requirement that the platform must not retain message content beyond a short window.
  • The conversation is high-sensitivity (PHI, financial, identity verification) and you do not want it sitting in storage long-term.
  • Your application is the system of record — you capture what you need from the delivery webhook in real time and do not rely on reading message history back from Linq later.

Important: ephemeral applies in both directions — messages you send and messages received by the phone numbers in that scope. Because Linq can no longer return the message once its window passes, persist anything you need to keep from the webhook payload at the time it is delivered.

Create and send a poll in a chat
POST/v3/chats/{chatId}/polls
ModelsExpand Collapse
Poll object { options, total_voters }

Poll content — options and the aggregate voter count.

options: array of object { can_be_edited, creator_handle, option_id, 2 more }
can_be_edited: boolean
creator_handle: ChatHandle { id, handle, joined_at, 4 more }

The participant who added this option (poll creator for the initial options; whoever added later ones).

id: string

Unique identifier for this handle

formatuuid
handle: string

Phone number (E.164) or email address of the participant

joined_at: string

When this participant joined the chat

formatdate-time
service: ServiceType

Messaging service type

One of the following:
"iMessage"
"SMS"
"RCS"
is_me: optional boolean

Whether this handle belongs to the sender (your phone number)

left_at: optional string

When they left (if applicable)

formatdate-time
status: optional "active" or "left" or "removed"

Participant status

One of the following:
"active"
"left"
"removed"
option_id: string
formatuuid
text: string
voters: array of object { handle, voted_at }

Participants who voted for this option (vote_count = voters.length).

handle: string
voted_at: string
formatdate-time
total_voters: number

Distinct participants across the whole poll (a voter picking two options counts once).

PollEnvelope object { chat_id, created_at, message_id, 3 more }

Message-level envelope returned by every poll endpoint.

chat_id: string
formatuuid
created_at: string
formatdate-time
message_id: string

The poll-definition message’s ID — reference this poll by it.

formatuuid
poll: Poll { options, total_voters }

Poll content — options and the aggregate voter count.

options: array of object { can_be_edited, creator_handle, option_id, 2 more }
can_be_edited: boolean
creator_handle: ChatHandle { id, handle, joined_at, 4 more }

The participant who added this option (poll creator for the initial options; whoever added later ones).

id: string

Unique identifier for this handle

formatuuid
handle: string

Phone number (E.164) or email address of the participant

joined_at: string

When this participant joined the chat

formatdate-time
service: ServiceType

Messaging service type

One of the following:
"iMessage"
"SMS"
"RCS"
is_me: optional boolean

Whether this handle belongs to the sender (your phone number)

left_at: optional string

When they left (if applicable)

formatdate-time
status: optional "active" or "left" or "removed"

Participant status

One of the following:
"active"
"left"
"removed"
option_id: string
formatuuid
text: string
voters: array of object { handle, voted_at }

Participants who voted for this option (vote_count = voters.length).

handle: string
voted_at: string
formatdate-time
total_voters: number

Distinct participants across the whole poll (a voter picking two options counts once).

reactions: array of Reaction { handle, is_me, type, 3 more }

Tapbacks/stickers on the whole poll (message part 0).

handle: ChatHandle { id, handle, joined_at, 4 more }
id: string

Unique identifier for this handle

formatuuid
handle: string

Phone number (E.164) or email address of the participant

joined_at: string

When this participant joined the chat

formatdate-time
service: ServiceType

Messaging service type

One of the following:
"iMessage"
"SMS"
"RCS"
is_me: optional boolean

Whether this handle belongs to the sender (your phone number)

left_at: optional string

When they left (if applicable)

formatdate-time
status: optional "active" or "left" or "removed"

Participant status

One of the following:
"active"
"left"
"removed"
is_me: boolean

Whether this reaction is from the current user

Type of reaction. Standard iMessage tapbacks are love, like, dislike, laugh, emphasize, question. Custom emoji reactions have type “custom” with the actual emoji in the custom_emoji field. Sticker reactions have type “sticker” with sticker attachment details in the sticker field.

One of the following:
"love"
"like"
"dislike"
"laugh"
"emphasize"
"question"
"custom"
"sticker"
id: optional string

Identifier for this reaction. Pass it to PATCH /v3/messages/{messageId}/reactions/{reactionId} to move a sticker.

Stickers placed before this API shipped can be read but not moved: the device-side reference needed to reposition them was never recorded, so PATCH returns 404 for those.

formatuuid
custom_emoji: optional string

Custom emoji if type is “custom”, null otherwise

sticker: optional object { file_name, height, mime_type, 2 more }

Sticker attachment details when reaction_type is “sticker”. Null for non-sticker reactions.

file_name: optional string

Filename of the sticker

height: optional number

Sticker image height in pixels

mime_type: optional string

MIME type of the sticker image

url: optional string

Presigned URL for downloading the sticker image (expires in 1 hour).

formaturi
width: optional number

Sticker image width in pixels

updated_at: string
formatdate-time