Skip to main content
Linq logo
  • Category: communication
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 68
  • Triggers: 0
  • Slug: LINQ
  • Version: 20261101_00

Tools

Slug: LINQ_ADD_CHAT_PARTICIPANTAdd an external participant to an existing group chat. The participant-visible change is queued asynchronously.

Input Parameters

string
required
Phone number in E.164 format or email address of the participant to add.
string
required
Unique identifier of the group chat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_ADD_POLL_OPTIONSIrreversibly add recipient-visible options to an existing iMessage poll. Poll options cannot be edited or removed after they are added.

Input Parameters

array
required
Options to append. On a zero-day-retention line, include every existing option in original order followed by the new options.
string
required
Poll-definition message ID returned when the poll was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_BLOCK_HANDLEBlock a handle account-wide from inbound and direct outbound messaging. Pair controlled test blocks with UNBLOCK_HANDLE cleanup.

Input Parameters

string
required
Handle to block account-wide: an E.164 phone number, email address, 3-8 digit SMS short code, or alphanumeric sender ID.
string
Optional free-text note explaining why the handle is blocked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_CANCEL_PAYMENTIrreversibly cancel a financial payment and close its virtual card. Confirm the payment identifier and authorization before calling because the canceled payment cannot be resumed.

Input Parameters

string
required
Payment identifier whose virtual card and payment will be canceled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_CANCEL_PAYMENT_REQUESTIrreversibly cancel an unpaid payment request and its underlying payment intent. The checkout can no longer be completed after cancellation; paid, canceled, or expired requests cannot be canceled. Confirm the request ID and intent first.

Input Parameters

string
required
Unique ID of the unpaid payment request to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_CHECK_MESSAGING_CAPABILITYCheck whether a recipient can receive iMessage or RCS without sending a message. Linq permits only one capability check per 10 seconds; cache successful answers briefly (minutes, not days) instead of checking before every send.

Input Parameters

string
required
Recipient E.164 phone number, or an email address for an iMessage check.
string ("iMessage" | "RCS")
required
Messaging service to check. RCS accepts E.164 phone numbers only; iMessage accepts E.164 phone numbers or email addresses.
string
Optional sender line in E.164 format. Omit it to let Linq choose an available line.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_CONNECT_PAYMENT_HANDLEStart the financial-consent ceremony for a customer phone number or email so an agent can later pay on that customer’s behalf. This consent-sensitive, irreversible action may contact the customer and send an OTP; call it only with the customer’s explicit consent.

Input Parameters

string
required
Consenting customer’s phone number in E.164 format or email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_CREATE_CHATCreate or reuse a chat on an explicit sending line and send an irreversible recipient-visible initial message. Initial text cannot contain URLs, and rich link parts are not allowed.

Input Parameters

object
required
Initial message for the new chat.
array
required
Recipient phone numbers in E.164 format or email addresses.
boolean
Send this request despite an existing recipient opt-out. The opt-out remains in place and the override is audited.
string
required
Authorized sender phone number in E.164 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_CREATE_PAYMENTCreate or advance a real financial payment on a connected customer’s behalf, potentially minting a single-use virtual card. This is consent-sensitive and financially consequential; obtain explicit customer authorization, verify the amount and merchant, and use an Idempotency-Key for retries.

Input Parameters

string
required
Consenting customer’s phone number in E.164 format or email address.
string
required
Currency code for the payment.
object
Optional merchant name and URL against which the virtual card is minted.
object
Optional caller-owned string metadata echoed on the payment.
string
Optional description of the purchase.
integer
required
Payment amount in minor currency units.
string
Optional stable key for safe retries of this exact payment request. Reuse the same key rather than creating a second financial operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_CREATE_PAYMENT_REQUESTCreate a customer-facing checkout that can collect a one-time charge or start an auto-renewing subscription. This creates financial state but does not itself send the checkout URL to a recipient. Confirm the amount, currency, mode, rail, and intended payer before calling; use idempotency_key for retries.

Input Parameters

string ("payment" | "subscription")
payment collects once; subscription starts automatic recurring billing.
string ("stripe" | "natural")
stripe settles to the connected Stripe account; natural uses Natural custodial wallets.
integer
One-time amount in minor currency units; required only in payment mode.
string
ISO 4217 currency code; currently usd and required only in payment mode.
object
One Stripe coupon or promotion code for a subscription.
object
Up to 49 correlation fields; keys beginning with linq_ are reserved.
string
Active recurring Stripe Price ID; required only in subscription mode.
integer
Subscription price quantity; Linq defaults it to 1 when omitted.
string
Future ISO 8601 subscription trial-end timestamp; mutually exclusive with trial_period_days.
string
Existing Stripe Customer ID on the connected account, when applicable.
string
Description shown to the recipient at checkout.
string
Payer E.164 phone number; required for the natural rail.
string
Key for safely retrying this creation without creating another payment request; reuse it only with identical parameters.
string
Organization-owned E.164 sending line; required for the natural rail.
integer
Subscription free-trial length in days; mutually exclusive with trial_end.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_CREATE_POLLIrreversibly send a recipient-visible iMessage poll to an existing chat. A poll cannot be the chat’s first message, and its options are add-only and immutable.

Input Parameters

object
required
Poll options and optional idempotency key.
string
required
Unique ID of the existing chat that receives the poll.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_CREATE_WEBHOOK_SUBSCRIPTIONCreate a webhook subscription for selected Linq events at a controlled HTTPS callback. The response includes a one-time signing secret that must be stored securely.

Input Parameters

string
required
HTTPS URL where Linq sends webhook events.
array
Optional E.164 sending-line filters. Omit or pass an empty list to receive events from all lines.
string
Optional header name used to carry the chat ID for routing. Ignored unless routing_key_header is set.
array
required
Event types to deliver. Use LIST_WEBHOOK_EVENTS to discover currently available values.
string
Optional header name used for Linq delivery-affinity routing tokens. This configures a header name, not a token value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_DELETE_ATTACHMENTPermanently delete a Linq attachment and its stored bytes.

Input Parameters

string
required
Unique identifier of the attachment to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_DELETE_MESSAGEIrreversibly delete a message record from Linq. This does not unsend the message or remove it from recipients’ devices, and its idempotency key cannot be reused to resend it.

Input Parameters

string
required
Unique ID of the message record to delete from Linq.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_DELETE_WEBHOOK_SUBSCRIPTIONPermanently delete a Linq webhook subscription and stop its future event deliveries.

Input Parameters

string
required
Unique identifier of the webhook subscription to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_EDIT_MESSAGEIrreversibly change recipient-visible text in one part of a message sent within the last 15 minutes; Linq permits at most five edits per message. An accepted edit may return no message fields.

Input Parameters

string
required
Replacement text for the selected message part.
string
required
Unique ID of the previously sent message to edit.
integer
Index of the message part to edit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_ATTACHMENTReturn metadata and current status for a Linq attachment referenced by a message. This metadata-only action does not download the file.

Input Parameters

string
required
Attachment ID found in a message part.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_AVAILABLE_NUMBERSelect an available Linq sending number, optionally for recipients or a line type. Treat the returned vCard URL as sensitive and ephemeral.

Input Parameters

string ("RCS" | "iMessage")
Only select an RCS or iMessage sending line.
array
Recipient E.164 numbers or emails used to make the line selection sticky to an existing matching chat.
array
E.164 sending lines to exclude from selection, up to 100 entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_CHATReturn one chat by ID, including participants, service, state, and health information.

Input Parameters

string
required
Unique chat ID returned by LINQ_LIST_CHATS or a send action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_CHAT_LOCATIONReturn precise locations currently shared by contacts in a chat. Treat coordinates and addresses as sensitive and minimize retention.

Input Parameters

string
required
Identifier of the chat whose actively shared locations should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_EXPERIENCEReturn one Linq experience and preserve its dynamic action field definitions. Discovery does not prove that required provider setup is complete.

Input Parameters

string
required
Experience key returned by LIST_EXPERIENCES, such as agentpay.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_MESSAGEReturn one Linq message by ID with its content parts, sender, actual and preferred transport, delivery state, reply target, and timestamps.

Input Parameters

string
required
Unique message ID returned by a message list, send action, or webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_PAYMENTRead a payment’s financial state, amount, customer handle, merchant details, and any customer-action URL. Treat returned identifiers and hosted URLs as sensitive financial metadata.

Input Parameters

string
required
Payment identifier returned by CREATE_PAYMENT.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_PAYMENT_CREDENTIALSReturn the complete, highly sensitive short-lived handoff used to reveal a ready payment’s virtual card directly from the provider. The response includes provider, user_token, card_ref, and fetch_url when supplied. Use it only for the immediate authorized checkout; never log, persist, or disclose the handoff or the resulting PAN/CVC.

Input Parameters

string
required
Ready payment identifier whose card-reveal handoff is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_PAYMENT_HANDLE_CONNECTIONRead the financial-consent connection status for a customer phone number or email. Query only a customer handle whose owner consented to this lookup; the response may include a transient connect_id for a pending ceremony.

Input Parameters

string
required
Consenting customer’s phone number in E.164 format or email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_PAYMENT_PROVIDERRead the organization’s onboarding status for a payment provider. This is a read-only financial setup check; a 404 is an execution failure and must not be interpreted as a normal disabled status.

Input Parameters

string
required
Payment-provider key, such as agentcard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_PAYMENT_REQUESTReturn one payment request’s amount, lifecycle status, checkout details, and provider join keys. This is read-only financial metadata; treat checkout URLs and customer or provider IDs as sensitive.

Input Parameters

string
required
Unique payment-request ID returned by create or list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_POLLReturn an iMessage poll’s current options, voters, and distinct voter count.

Input Parameters

string
required
Poll-definition message ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_REPUTATION_AUDITReturn a Linq line reputation audit created with explicit approval. Audits are retained for no more than 24 hours.

Input Parameters

string
required
Audit identifier returned by START_REPUTATION_AUDIT.
string
required
Audited Linq sending line in E.164 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_GET_WEBHOOK_SUBSCRIPTIONReturn one Linq webhook subscription by ID, including its callback URL, event and phone filters, active state, and configured routing-header names.

Input Parameters

string
required
Unique identifier of the webhook subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_LEAVE_CHATLeave an iMessage group chat. This is irreversible and prevents further interaction through the sending line.

Input Parameters

string
required
Unique identifier of the group chat to leave.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_LIST_BLOCKED_HANDLESReturn phone numbers, email addresses, short codes, and sender IDs currently blocked account-wide from inbound and direct outbound messaging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_LIST_CHATSReturn one page of chats, optionally filtered by sending line or participant, with a cursor for the next page.

Input Parameters

integer
Maximum chats to return in this page (1-100).
string
Opaque next_cursor from a previous LIST_CHATS response; omit for the first page.
string
Only return chats containing this participant phone number or email address.
string
Only return chats using this sender line in E.164 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_LIST_CONTACT_CARDSReturn Linq account contact-card identity data, optionally for one E.164 sending line.

Input Parameters

string
E.164 sending line to filter by. Omit to return all account contact cards.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_LIST_EXPERIENCESDiscover Linq experiences and their dynamic action fields. Availability in this response does not prove payment-provider onboarding is complete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_LIST_MESSAGESReturn one page of messages from a chat, including content, sender, transport, delivery state, direction, reply target, and timestamps, plus a cursor for older messages.

Input Parameters

integer
Maximum messages to return in this page (1-100).
string
Opaque next_cursor from a previous response; omit for the first page.
string
required
Chat whose messages to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_LIST_MESSAGE_THREADReturn one page containing the origin message and threaded replies, starting from any message in the thread. A message with no thread returns by itself.

Input Parameters

integer
Maximum thread messages to return in this page (1-100).
string ("asc" | "desc")
Sort messages oldest-first (asc) or newest-first (desc).
string
Opaque next_cursor from a previous response; omit for the first page.
string
required
ID of any message in the thread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_LIST_PAYMENT_REQUESTSReturn one newest-first page of payment requests for reconciliation, optionally filtered by lifecycle status. This is read-only financial metadata; checkout URLs and customer or provider IDs in results are sensitive.

Input Parameters

integer
Maximum payment requests in this page (1-100).
string
Opaque continuation cursor from a previous response; omit for the first page.
integer
Number of payment requests to skip on the first page.
string ("requested" | "authorized" | "succeeded" | "canceled" | "expired" | "declined")
Optional lifecycle-status filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_LIST_PHONE_NUMBERSReturn the connected Linq account’s sending lines with line type, forwarding configuration, and reputation status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_LIST_WEBHOOK_EVENTSReturn the webhook event types currently available for subscription on the connected Linq account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_LIST_WEBHOOK_SUBSCRIPTIONSReturn the connected Linq account’s webhook subscriptions, including event and phone-number filters, target URLs, active state, and routing-header names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_MARK_CHAT_AS_READMark every message in a chat as read and send an irreversible read receipt.

Input Parameters

string
required
Unique identifier of the chat to mark as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_REMOVE_CHAT_BACKGROUNDReset a chat’s recipient-visible transcript background to the default.

Input Parameters

string
required
Unique identifier of the chat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_REMOVE_CHAT_PARTICIPANTQueue removal of an external participant from a group chat. This changes recipient-visible conversation membership asynchronously.

Input Parameters

string
required
Phone number in E.164 format or email address of the participant to remove.
string
required
Unique identifier of the group chat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_REQUEST_ATTACHMENT_UPLOADReserve persistent attachment storage and return a 15-minute presigned upload URL. This action does not upload file bytes; PUT the raw bytes separately to the returned opaque URL using the exact required_headers.

Input Parameters

string
required
Name of the file to upload.
integer
required
Size of the file in bytes, from 1 byte through 100 MiB.
string ("image/jpeg" | "image/png" | "image/gif" | "image/heic" | "image/heif" | "image/tiff" | "image/bmp" | "image/svg+xml" | "image/webp" | "image/x-icon" | "video/mp4" | "video/quicktime" | "video/mpeg" | "video/mpeg2" | "video/x-m4v" | "video/x-msvideo" | "video/3gpp" | "audio/mpeg" | "audio/mp3" | "audio/x-m4a" | "audio/mp4" | "audio/x-caf" | "audio/x-wav" | "audio/x-aiff" | "audio/aiff" | "audio/aac" | "audio/midi" | "audio/amr" | "application/pdf" | "application/vnd.apple.pkpass" | "text/plain" | "text/markdown" | "text/vcard" | "text/rtf" | "text/csv" | "text/html" | "text/calendar" | "application/msword" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.ms-excel" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.ms-powerpoint" | "application/vnd.openxmlformats-officedocument.presentationml.presentation" | "application/x-iwork-pages-sffpages" | "application/x-iwork-numbers-sffnumbers" | "application/x-iwork-keynote-sffkey" | "application/epub+zip" | "text/xml" | "application/json" | "application/zip" | "application/x-gzip")
required
MIME type of the file to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_REQUEST_CHAT_LOCATIONPrompt a contact in a one-to-one iMessage chat to consent to sharing their precise location. This is recipient-visible and rate-limited per chat.

Input Parameters

string
required
Identifier of the one-to-one iMessage chat whose contact should be prompted to share location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_REVOKE_PAYMENT_HANDLE_CONNECTIONIrreversibly revoke this partner’s financial-consent grant for a customer phone number or email. This prevents future payments through the grant but does not delete the customer’s provider wallet; revoke only with explicit authorization.

Input Parameters

string
required
Customer phone number in E.164 format or email whose grant will be revoked.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_SEND_MESSAGESend one irreversible, externally visible message to phone numbers or emails. Linq reuses a matching chat or creates one and automatically selects the sending line.

Input Parameters

array
Ordered text, media, link, iMessage app, or App Clip parts. Link, iMessage app, and App Clip parts must each be the only part. Mutually exclusive with experience.
object
Optional iMessage screen or bubble effect.
object
Optional threaded-reply target.
object
Single experience invocation sent as the whole message. Mutually exclusive with parts.
array
required
Recipient E.164 phone numbers or email addresses. One creates a direct chat; multiple create a group.
string
Caller-generated key that prevents retries from sending twice.
array
E.164 sender lines not to choose for a new chat. Existing matching chats can still be reused on an excluded line.
string
Replacement text sent only when Linq fails over an existing chat from a flagged line to a new line.
string ("iMessage" | "RCS" | "SMS")
Optional delivery preference. iMessage has no fallback; RCS and SMS use Linq’s documented RCS-to-SMS behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_SEND_MESSAGE_TO_CHATSend one follow-up or threaded reply to an existing Linq chat using its established sending line. This creates an irreversible recipient-visible message.

Input Parameters

array
Ordered text, media, link, iMessage app, or App Clip parts. Mutually exclusive with experience.
object
Optional iMessage screen or bubble effect.
string
required
Existing chat that should receive the message.
object
Optional target for a threaded reply.
object
Single experience invocation sent as the whole message. Mutually exclusive with parts.
string
Caller-generated key that prevents a retry from sending twice.
string ("iMessage" | "SMS" | "RCS")
Preferred transport. iMessage has no fallback; RCS and SMS follow Linq’s documented RCS-to-SMS behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_SEND_VOICE_MEMO_TO_CHATIrreversibly send recipient-visible audio as a native iMessage voice memo bubble to every participant in an existing Linq chat.

Input Parameters

string
required
Unique identifier of the chat that will receive the voice memo.
string
ID of a voice-memo file pre-uploaded to Linq. Provide exactly one of attachment_id or voice_memo_url.
string
Publicly accessible HTTPS URL of an MP3, M4A, AAC, CAF, WAV, AIFF, or AMR audio file. Provide exactly one of voice_memo_url or attachment_id.
boolean
Send despite the recipient’s opt-out. The opt-out remains active and Linq records every override against the API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_SET_CHAT_BACKGROUNDSet a recipient-visible color, animated, or photo transcript background. Linq processes the change asynchronously.

Input Parameters

string ("color" | "dynamic" | "photo")
required
Background family to apply.
string ("sky" | "water" | "aurora")
Animated style for a dynamic background.
array
Two hexadecimal gradient stops for a custom color background.
string
required
Unique identifier of the chat.
string ("mango" | "ice" | "plum" | "deep_sea" | "green_apple" | "cherry" | "bubblegum" | "tangerine" | "magenta" | "lime" | "silver" | "carbon" | "stone" | "custom" | "dusk" | "haze" | "sunset" | "clear" | "sunrise" | "dawn" | "light" | "dark" | "green" | "purple" | "pink")
Named color swatch, custom color, or dynamic variant for the selected style.
string
Fetchable HTTPS image URL for a photo background.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_SET_UP_CONTACT_CARDCreate or replace a Linq contact card for a sending line. This changes public account identity and may activate contact-card sharing.

Input Parameters

string
Optional HTTPS profile image URL for the contact card.
string
Optional last name for the contact card.
string
required
Required first name for the contact card.
string
required
E.164 sending line to associate with the contact card.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_SHARE_CONTACT_CARD_WITH_CHATShare the connected sending line’s active contact card with a chat. This irreversibly discloses account identity to recipients.

Input Parameters

string
required
Unique identifier of the chat that should receive the active contact card.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_START_PAYMENT_PROVIDER_ONBOARDINGCreate a hosted payment-provider onboarding session for the organization. This starts an external Stripe/Agentcard authorization flow and returns a sensitive hosted URL that an authorized administrator must open; do not use it to complete production onboarding without explicit administrative consent.

Input Parameters

string
required
Payment-provider key, such as agentcard.
string
required
URL where Linq redirects the administrator after authorization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_START_REPUTATION_AUDITStart a potentially metered or limited reputation audit for a Linq sending line. The resulting audit persists for 24 hours.

Input Parameters

string
required
Linq sending line to audit in E.164 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_START_TYPING_INDICATORShow a best-effort recipient-visible typing indicator for about 85-90 seconds. Primarily effective for active iMessage chats.

Input Parameters

string
required
Unique identifier of the chat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_STOP_CHAT_LOCATION_SHARINGStop a specific contact’s inbound location share. This consent-sensitive operation ends that contact’s share across chats.

Input Parameters

string
required
Phone number in E.164 format or email address of the contact whose share should end.
string
required
Identifier of the chat whose inbound location share should be ended.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_STOP_TYPING_INDICATORImmediately clear the connected line’s recipient-visible typing indicator for a chat.

Input Parameters

string
required
Unique identifier of the chat.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_TOGGLE_POLL_VOTEIrreversibly send a recipient-visible update that adds or removes the connected line’s vote on one option of an iMessage poll.

Input Parameters

string ("add" | "remove")
required
Add or remove the connected line’s vote on the option.
string
required
Unique ID of the option whose vote will be toggled.
string
required
Poll-definition message ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_UNBLOCK_HANDLERemove an account-wide messaging block. This changes messaging behavior; for testing, unblock only a handle blocked by the same test.

Input Parameters

string
required
Account-wide blocked handle to unblock.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_UPDATE_CHATUpdate a group chat’s display name or icon. The participant-visible change is processed asynchronously.

Input Parameters

string
required
Unique identifier of the chat.
string
New display name for the group chat.
string
Image URL to set as the group chat icon.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_UPDATE_CONTACT_CARDUpdate the public contact-card identity for one Linq sending line.

Input Parameters

string
Updated profile image URL. Omit to preserve the existing image.
string
Updated last name. Omit to preserve the existing value.
string
Updated first name. Omit to preserve the existing value.
string
required
E.164 sending line whose contact card should be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_UPDATE_IMESSAGE_APP_CARDIrreversibly send a recipient-visible in-place update to an iMessage app card. The update creates a new message version; use its returned message ID for the next serialized update.

Input Parameters

object
Original app identity. Required for a raw URL update on a zero-day-retention line; ignored for an experience update.
string
New card destination URL. Mutually exclusive with experience.
object
required
Visible layout of the updated card.
object
Experience action that builds the card. Mutually exclusive with url.
string
required
ID of the original app-card message or its most recent update.
boolean
Whether installed extensions render an interactive balloon.
string
Text shown on surfaces that cannot render the updated card.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_UPDATE_MESSAGE_REACTIONIrreversibly mutate recipient-visible reaction state by adding or removing a tapback, or by adding an iMessage sticker. Stickers cannot be removed.

Input Parameters

string
Linq-hosted HTTPS sticker URL; valid only when type is sticker.
string ("love" | "like" | "dislike" | "laugh" | "emphasize" | "question" | "custom" | "sticker")
required
Standard tapback, custom tapback, or sticker type.
string
Emoji sticker source; valid only when type is sticker.
string ("add" | "remove")
required
Whether to add or remove the reaction.
object
Optional sticker position, size, and rotation.
string
required
Unique ID of the message to react to.
integer
Optional index of the message part to react to.
string
Tapback emoji; required only when type is custom.
string
Pre-uploaded sticker attachment ID; valid only when type is sticker.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_UPDATE_PHONE_NUMBERChange a Linq sending line’s production forwarding configuration. Capture the current value before changing it when rollback is required.

Input Parameters

string
required
UUID of the Linq sending line to update.
string
required
Forwarding number in E.164 format. Send null or an empty string to clear it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_UPDATE_STICKER_PLACEMENTIrreversibly send a recipient-visible update that moves, resizes, or rotates an existing iMessage sticker on a message.

Input Parameters

object
required
Sticker placement fields to change; omitted fields keep their current values.
string
required
ID of the message on which the sticker is placed.
string
required
ID of the sticker reaction to move.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_UPDATE_WEBHOOK_SUBSCRIPTIONUpdate a Linq webhook subscription’s callback, filters, active state, or routing-header names. Callback and routing changes can redirect future account events.

Input Parameters

boolean
Set whether delivery is active. Omit to preserve the current state.
string
New HTTPS callback URL. Omit to leave the callback unchanged.
array
Replacement E.164 filters. Pass an empty list or null to receive events from all lines; omit to leave filters unchanged.
string
required
Unique identifier of the webhook subscription.
string
Replacement chat-ID header name. Pass null or an empty string to use Linq-Chat-Id; omit to leave it unchanged.
array
Replacement event list. Omit to leave subscribed events unchanged.
string
Replacement routing-token header name. Pass null or an empty string to disable affinity and drop stored tokens; omit to leave it unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: LINQ_VERIFY_PAYMENT_HANDLESubmit a customer’s single-use OTP to complete the financial-consent ceremony and authorize future payments on the customer’s behalf. This irreversible, consent-sensitive action consumes the code and records consent; use only a code the customer explicitly provided for this connection.

Input Parameters

string
required
Single-use, short-lived one-time code received by the customer.
string
required
Consenting customer’s phone number in E.164 format or email address.
string
required
Transient connection ID returned by CONNECT_PAYMENT_HANDLE.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not