Use Linq to send and read messages over iMessage, SMS, and RCS with an API key.
The 34 operations cover chats, messages, attachments, phone numbers, capability checks, contact cards, and webhook subscriptions. Send media, link previews, effects, tapback reactions, inline replies, voice memos, or edited messages; and manage group participants, names, and icons.
Check iMessage or RCS capability before selecting a preferred service. Upload attachments up to the operation's 100 MB limit. Webhook subscriptions cover message, reaction, participant, and call events, with HMAC-SHA256 signature verification.
Reach people on iMessage, SMS, and RCS through Linq. Start chats, send messages with media, links, effects, and replies, send voice memos, react with tapbacks, manage group participants, check iMessage/RCS capability, configure contact cards, and subscribe to webhook events — all through a single Linq API key.
Add a participant to a group chat (3+ existing participants)
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key chatIdstring Yes The unique identifier of the group chat handlestring Yes Phone number (E.164 format) or email address of the participant to add
Parameter Type Description messagestring Human-readable status message statusstring Queued action status traceIdstring Trace ID for the queued action
Check whether an address (phone number or email) supports iMessage
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key addressstring Yes Phone number (E.164 format) or email address to check fromstring No Sender phone number to check from (defaults to an available number)
Parameter Type Description addressstring The address that was checked availableboolean Whether the address supports iMessage
Check whether an address (phone number or email) supports RCS
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key addressstring Yes Phone number (E.164 format) to check fromstring No Sender phone number to check from (defaults to an available number)
Parameter Type Description addressstring The address that was checked availableboolean Whether the address supports RCS
Upload a file to Linq as a reusable attachment (max 100MB) and get an attachment ID to send in messages
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key filefile No File to upload (a UserFile from a file-upload field or a previous block) filenamestring No Override the file name (defaults to the uploaded file name) contentTypestring No Override the MIME type (defaults to the uploaded file type)
Parameter Type Description attachmentIdstring Reusable attachment ID to reference when sending messages or voice memos downloadUrlstring URL the attachment can be downloaded from filenamestring File name contentTypestring MIME type of the file sizeBytesnumber File size in bytes statusstring Upload status
Start a new iMessage, SMS, or RCS chat and send the first message
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key fromstring Yes Sender phone number in E.164 format (e.g. +14155551234) toarray Yes Recipient handles (phone numbers in E.164 format or email addresses) textstring No Text content of the first message. Optional, but at least one of text, media, attachment, or link is required mediaUrlstring No Optional publicly accessible HTTPS URL of an image, video, or file to attach attachmentIdstring No Optional ID of a pre-uploaded attachment to send instead of a media URL preferredServicestring No Preferred delivery service: iMessage, SMS, or RCS effectNamestring No Optional iMessage effect name (e.g. confetti, fireworks, lasers) effectTypestring No Optional effect type: screen or bubble replyToMessageIdstring No Optional message ID to reply to inline replyToPartIndexnumber No Optional part index of the message being replied to idempotencyKeystring No Optional idempotency key to safely retry the request
Parameter Type Description chatIdstring ID of the created chat displayNamestring Display name of the chat isGroupboolean Whether the chat is a group chat servicestring Delivery service used (iMessage, SMS, RCS) handlesjson Participant handles in the chat healthStatusjson Messaging line health status messagejson The sent message object with parts and delivery info
Set up a contact card (Name and Photo Sharing) for a phone number
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key phoneNumberstring Yes Phone number in E.164 format the card applies to firstNamestring Yes First name to display lastNamestring No Last name to display imageUrlstring No Profile photo URL
Parameter Type Description phoneNumberstring Phone number the card applies to firstNamestring First name lastNamestring Last name imageUrlstring Profile photo URL isActiveboolean Whether the card is active
Subscribe an HTTPS endpoint to Linq webhook events
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key targetUrlstring Yes HTTPS endpoint that will receive webhook events subscribedEventsarray Yes Event types to subscribe to (e.g. message.sent, message.delivered) phoneNumbersarray No E.164 phone numbers to filter events by (omit for all numbers)
Parameter Type Description idstring Subscription ID targetUrlstring Endpoint that receives events subscribedEventsjson Subscribed event types phoneNumbersjson Filtered phone numbers (null = all) isActiveboolean Whether the subscription is active createdAtstring ISO 8601 creation timestamp updatedAtstring ISO 8601 update timestamp signingSecretstring HMAC-SHA256 signing secret. Store securely — it cannot be retrieved again
Permanently delete an attachment owned by your account
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key attachmentIdstring Yes The unique identifier of the attachment to delete
Parameter Type Description successboolean Whether the attachment was deleted
Delete a message from the Linq API only (does not unsend it; recipients still see it)
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key messageIdstring Yes The unique identifier of the message to delete
Parameter Type Description successboolean Whether the message was deleted
Delete a webhook subscription from your account
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key subscriptionIdstring Yes The unique identifier of the webhook subscription to delete
Parameter Type Description successboolean Whether the subscription was deleted
Edit the text of a sent message (up to 5 times, within 15 minutes of sending; iMessage only)
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key messageIdstring Yes The unique identifier of the message to edit textstring Yes New text content for the message part partIndexnumber No Index of the message part to edit (defaults to 0)
Parameter Type Description idstring Message ID chatIdstring ID of the chat the message belongs to isFromMeboolean Whether the message was sent by you deliveryStatusstring Delivery status (pending, queued, sent, delivered, received, read, failed) isDeliveredboolean Whether the message was delivered (deprecated; use deliveryStatus) isReadboolean Whether the message was read (deprecated; use deliveryStatus) servicestring Delivery service (iMessage, SMS, RCS) createdAtstring ISO 8601 creation timestamp updatedAtstring ISO 8601 update timestamp sentAtstring ISO 8601 sent timestamp partsjson Updated message parts with reactions messagejson The full updated message object
Retrieve metadata for an attachment, including its download URL and status
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key attachmentIdstring Yes The unique identifier of the attachment
Parameter Type Description idstring Attachment ID filenamestring File name contentTypestring MIME type of the file sizeBytesnumber File size in bytes statusstring Upload status (pending, complete, failed) downloadUrlstring URL to download the file createdAtstring ISO 8601 creation timestamp
Retrieve a chat by ID, including participants and line health
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key chatIdstring Yes The unique identifier of the chat
Parameter Type Description idstring Chat ID displayNamestring Display name of the chat isGroupboolean Whether the chat is a group chat isArchivedboolean Whether the chat is archived servicestring Delivery service (iMessage, SMS, RCS) createdAtstring ISO 8601 creation timestamp updatedAtstring ISO 8601 update timestamp handlesjson Participant handles in the chat healthStatusjson Messaging line health status
Retrieve contact cards, optionally filtered by phone number
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key phoneNumberstring No E.164 phone number to filter by (omit to return all cards)
Parameter Type Description contactCardsarray Contact cards on the account ↳ phoneNumber string Phone number in E.164 format ↳ firstName string First name ↳ lastName string Last name ↳ imageUrl string Profile photo URL ↳ isActive boolean Whether the card is active
Retrieve a single message by ID, including parts, reactions, and delivery status
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key messageIdstring Yes The unique identifier of the message
Parameter Type Description idstring Message ID chatIdstring ID of the chat the message belongs to isFromMeboolean Whether the message was sent by you deliveryStatusstring Delivery status (pending, queued, sent, delivered, received, read, failed) isDeliveredboolean Whether the message was delivered (deprecated; use deliveryStatus) isReadboolean Whether the message was read (deprecated; use deliveryStatus) servicestring Delivery service (iMessage, SMS, RCS) createdAtstring ISO 8601 creation timestamp updatedAtstring ISO 8601 update timestamp sentAtstring ISO 8601 sent timestamp partsjson Message parts (text, media, link) with reactions messagejson The full message object
Retrieve a webhook subscription by ID
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key subscriptionIdstring Yes The unique identifier of the webhook subscription
Parameter Type Description idstring Subscription ID targetUrlstring Endpoint that receives events subscribedEventsjson Subscribed event types phoneNumbersjson Filtered phone numbers (null = all) isActiveboolean Whether the subscription is active createdAtstring ISO 8601 creation timestamp updatedAtstring ISO 8601 update timestamp
Leave an iMessage group chat (4+ active participants; not supported for direct chats)
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key chatIdstring Yes The unique identifier of the group chat
Parameter Type Description messagestring Human-readable status message statusstring Queued action status (e.g. accepted) traceIdstring Trace ID for the queued action
List chats, optionally filtered by sender or participant handle
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key fromstring No Filter by sender phone number in E.164 format tostring No Filter by participant handle (phone number or email) limitnumber No Results per page (default 20, max 100) cursorstring No Pagination cursor from a previous response
Parameter Type Description chatsjson Array of chat objects nextCursorstring Cursor for the next page, or null if there are no more results
List messages in a chat with pagination
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key chatIdstring Yes The unique identifier of the chat limitnumber No Maximum number of messages to return cursorstring No Pagination cursor from a previous response
Parameter Type Description messagesjson Array of message objects with parts and reactions nextCursorstring Cursor for the next page, or null if there are no more results
List all phone numbers assigned to your partner account, with line health
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key
Parameter Type Description phoneNumbersarray Phone numbers assigned to the account ↳ id string Phone number ID ↳ phoneNumber string Phone number in E.164 format ↳ forwardingNumber string Forwarding number in E.164 format, or null ↳ healthStatus json Line reputation/health status (status, doc_url)
List all messages in the thread that contains a given message
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key messageIdstring Yes The ID of any message in the thread orderstring No Sort order: asc (oldest first) or desc (newest first) limitnumber No Maximum number of messages to return cursorstring No Pagination cursor from a previous response
Parameter Type Description messagesjson Array of message objects in the thread nextCursorstring Cursor for the next page, or null if there are no more results
List all webhook event types available to subscribe to
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key
Parameter Type Description eventsjson Available webhook event type names docUrlstring Documentation URL for webhook events
List all webhook subscriptions on your account
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key
Parameter Type Description subscriptionsarray Webhook subscriptions ↳ id string Subscription ID ↳ targetUrl string Endpoint that receives events ↳ subscribedEvents json Subscribed event types ↳ phoneNumbers json Filtered phone numbers (null = all) ↳ isActive boolean Whether the subscription is active ↳ createdAt string ISO 8601 creation timestamp ↳ updatedAt string ISO 8601 update timestamp
Mark messages in a chat as read (only applies to 1:1 iMessage/RCS; no effect on group chats)
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key chatIdstring Yes The unique identifier of the chat
Parameter Type Description successboolean Whether the chat was marked as read
Add or remove a tapback reaction on a message
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key messageIdstring Yes The unique identifier of the message to react to operationstring Yes Whether to add or remove the reaction: add or remove typestring Yes Reaction type: love, like, dislike, laugh, emphasize, question, custom, or sticker customEmojistring No Emoji to use when type is custom partIndexnumber No Index of the message part to react to (defaults to the entire message)
Parameter Type Description messagestring Human-readable status message statusstring Queued action status traceIdstring Trace ID for the queued action
Remove a participant from a group chat (minimum 3 participants must remain)
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key chatIdstring Yes The unique identifier of the group chat handlestring Yes Phone number (E.164 format) or email address of the participant to remove
Parameter Type Description messagestring Human-readable status message statusstring Queued action status traceIdstring Trace ID for the queued action
Send a message to an existing chat, with optional media, link, effect, or reply
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key chatIdstring Yes The unique identifier of the chat textstring No Text content of the message. Optional, but at least one of text, media, attachment, or link is required mediaUrlstring No Optional publicly accessible HTTPS URL of an image, video, or file to attach attachmentIdstring No Optional ID of a pre-uploaded attachment to send instead of a media URL linkUrlstring No Optional URL to send as a rich link preview. Linq requires a link to be its own message, so when set, text and media are ignored preferredServicestring No Preferred delivery service: iMessage, SMS, or RCS effectNamestring No Optional iMessage effect name (e.g. confetti, fireworks, lasers) effectTypestring No Optional effect type: screen or bubble replyToMessageIdstring No Optional message ID to reply to inline replyToPartIndexnumber No Optional part index of the message being replied to idempotencyKeystring No Optional idempotency key to safely retry the request
Parameter Type Description chatIdstring ID of the chat the message was sent to messageIdstring ID of the sent message deliveryStatusstring Delivery status (pending, queued, sent, delivered, received, read, failed) sentAtstring ISO 8601 timestamp the message was sent servicestring Delivery service (iMessage, SMS, RCS) messagejson The full sent message object with parts
Send a voice memo to a chat from a URL or a pre-uploaded attachment
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key chatIdstring Yes The unique identifier of the chat voiceMemoUrlstring No Publicly accessible HTTPS URL of the audio file (MP3, M4A, AAC, CAF, WAV, AIFF, AMR) attachmentIdstring No ID of a pre-uploaded audio attachment (use instead of voiceMemoUrl)
Parameter Type Description idstring ID of the sent voice memo message statusstring Delivery status fromstring Sender handle tojson Recipient handles servicestring Delivery service (iMessage, SMS, RCS) voiceMemojson Audio file metadata (id, filename, mime_type, size_bytes, url, duration_ms)
Share your configured contact card (Name and Photo Sharing) with a chat
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key chatIdstring Yes The unique identifier of the chat
Parameter Type Description successboolean Whether the contact card was shared
Show a typing indicator in a one-on-one chat (iMessage only, not group chats)
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key chatIdstring Yes The unique identifier of the chat
Parameter Type Description successboolean Whether the typing indicator was sent
Stop the typing indicator in a one-on-one chat (iMessage only, not group chats)
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key chatIdstring Yes The unique identifier of the chat
Parameter Type Description successboolean Whether the typing indicator was stopped
Update chat properties such as group display name and icon
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key chatIdstring Yes The unique identifier of the chat displayNamestring No New display name for the group chat groupChatIconstring No New group chat icon (publicly accessible image URL)
Parameter Type Description chatIdstring ID of the updated chat statusstring Status of the queued update
Partially update an existing active contact card for a phone number
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key phoneNumberstring Yes Phone number in E.164 format identifying the card to update firstNamestring No New first name lastNamestring No New last name imageUrlstring No New profile photo URL
Parameter Type Description phoneNumberstring Phone number the card applies to firstNamestring First name lastNamestring Last name imageUrlstring Profile photo URL isActiveboolean Whether the card is active
Update a webhook subscription (target URL, events, phone filter, or active state)
Inputs and outputsParameter Type Required Description apiKeystring Yes Linq API key subscriptionIdstring Yes The unique identifier of the webhook subscription targetUrlstring No New HTTPS endpoint that will receive events subscribedEventsarray No New set of event types to subscribe to phoneNumbersarray No New set of E.164 phone numbers to filter by isActiveboolean No Whether the subscription should be active
Parameter Type Description idstring Subscription ID targetUrlstring Endpoint that receives events subscribedEventsjson Subscribed event types phoneNumbersjson Filtered phone numbers (null = all) isActiveboolean Whether the subscription is active createdAtstring ISO 8601 creation timestamp updatedAtstring ISO 8601 update timestamp
A trigger starts a workflow when a supported event occurs in this service.
Trigger workflow when a message is delivered
Parameter Type Required Description triggerApiKeystring Yes Required to create the webhook subscription in Linq. triggerPhoneNumbersstring No Comma-separated E.164 numbers to restrict which numbers deliver events.
Parameter Type Description eventTypestring Event type (e.g. message.received, message.delivered, reaction.added) eventIdstring Unique event identifier used for deduplication createdAtstring ISO 8601 timestamp of when the event occurred webhookVersionstring Payload schema version of the delivered event datajson Full event payload (shape varies by event type — message, reaction, chat, etc.)
Trigger workflow when a message fails to deliver
Parameter Type Required Description triggerApiKeystring Yes Required to create the webhook subscription in Linq. triggerPhoneNumbersstring No Comma-separated E.164 numbers to restrict which numbers deliver events.
Parameter Type Description eventTypestring Event type (e.g. message.received, message.delivered, reaction.added) eventIdstring Unique event identifier used for deduplication createdAtstring ISO 8601 timestamp of when the event occurred webhookVersionstring Payload schema version of the delivered event datajson Full event payload (shape varies by event type — message, reaction, chat, etc.)
Trigger workflow when a message is read
Parameter Type Required Description triggerApiKeystring Yes Required to create the webhook subscription in Linq. triggerPhoneNumbersstring No Comma-separated E.164 numbers to restrict which numbers deliver events.
Parameter Type Description eventTypestring Event type (e.g. message.received, message.delivered, reaction.added) eventIdstring Unique event identifier used for deduplication createdAtstring ISO 8601 timestamp of when the event occurred webhookVersionstring Payload schema version of the delivered event datajson Full event payload (shape varies by event type — message, reaction, chat, etc.)
Trigger workflow when an inbound message is received
Parameter Type Required Description triggerApiKeystring Yes Required to create the webhook subscription in Linq. triggerPhoneNumbersstring No Comma-separated E.164 numbers to restrict which numbers deliver events.
Parameter Type Description eventTypestring Event type (e.g. message.received, message.delivered, reaction.added) eventIdstring Unique event identifier used for deduplication createdAtstring ISO 8601 timestamp of when the event occurred webhookVersionstring Payload schema version of the delivered event datajson Full event payload (shape varies by event type — message, reaction, chat, etc.)
Trigger workflow when a reaction is added to a message
Parameter Type Required Description triggerApiKeystring Yes Required to create the webhook subscription in Linq. triggerPhoneNumbersstring No Comma-separated E.164 numbers to restrict which numbers deliver events.
Parameter Type Description eventTypestring Event type (e.g. message.received, message.delivered, reaction.added) eventIdstring Unique event identifier used for deduplication createdAtstring ISO 8601 timestamp of when the event occurred webhookVersionstring Payload schema version of the delivered event datajson Full event payload (shape varies by event type — message, reaction, chat, etc.)
Trigger on any Linq webhook event (messages, reactions, chats, and more)
Parameter Type Required Description triggerApiKeystring Yes Required to create the webhook subscription in Linq. triggerPhoneNumbersstring No Comma-separated E.164 numbers to restrict which numbers deliver events.
Parameter Type Description eventTypestring Event type (e.g. message.received, message.delivered, reaction.added) eventIdstring Unique event identifier used for deduplication createdAtstring ISO 8601 timestamp of when the event occurred webhookVersionstring Payload schema version of the delivered event datajson Full event payload (shape varies by event type — message, reaction, chat, etc.)