> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Linq

> Send and manage iMessage, RCS, and SMS conversations, attachments, phone numbers, payments, and webhooks through the Linq Partner API.

![Linq logo](https://mintcdn.com/composio-preview/ufpARLIsio16odJB/images/toolkits/linq.svg?fit=max\&auto=format\&n=ufpARLIsio16odJB\&q=85\&s=aa0fb9823e2a6ddc07710dab2c2f368b)

* **Category:** communication
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 68
* **Triggers:** 0
* **Slug:** `LINQ`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Chat Participant
>
> **Slug:** `LINQ_ADD_CHAT_PARTICIPANT`
>
> Add an external participant to an existing group chat. The participant-visible change is queued asynchronously.
>
> #### Input Parameters
>
> **handle** `string` *required*
>
> Phone number in E.164 format or email address of the participant to add.
>
> **chat\_id** `string` *required*
>
> Unique identifier of the group chat.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Poll Options
>
> **Slug:** `LINQ_ADD_POLL_OPTIONS`
>
> Irreversibly add recipient-visible options to an existing iMessage poll. Poll options cannot be edited or removed after they are added.
>
> #### Input Parameters
>
> **options** `array` *required*
>
> Options to append. On a zero-day-retention line, include every existing option in original order followed by the new options.
>
> **message\_id** `string` *required*
>
> Poll-definition message ID returned when the poll was created.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Block Handle
>
> **Slug:** `LINQ_BLOCK_HANDLE`
>
> Block a handle account-wide from inbound and direct outbound messaging. Pair controlled test blocks with UNBLOCK\_HANDLE cleanup.
>
> #### Input Parameters
>
> **handle** `string` *required*
>
> Handle to block account-wide: an E.164 phone number, email address, 3-8 digit SMS short code, or alphanumeric sender ID.
>
> **reason** `string`
>
> Optional free-text note explaining why the handle is blocked.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Payment
>
> **Slug:** `LINQ_CANCEL_PAYMENT`
>
> Irreversibly 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
>
> **payment\_id** `string` *required*
>
> Payment identifier whose virtual card and payment will be canceled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Payment Request
>
> **Slug:** `LINQ_CANCEL_PAYMENT_REQUEST`
>
> Irreversibly 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
>
> **payment\_request\_id** `string` *required*
>
> Unique ID of the unpaid payment request to cancel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Messaging Capability
>
> **Slug:** `LINQ_CHECK_MESSAGING_CAPABILITY`
>
> Check 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
>
> **address** `string` *required*
>
> Recipient E.164 phone number, or an email address for an iMessage check.
>
> **service** `string ("iMessage" | "RCS")` *required*
>
> Messaging service to check. RCS accepts E.164 phone numbers only; iMessage accepts E.164 phone numbers or email addresses.
>
> **from\_phone\_number** `string`
>
> Optional sender line in E.164 format. Omit it to let Linq choose an available line.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Connect Payment Handle
>
> **Slug:** `LINQ_CONNECT_PAYMENT_HANDLE`
>
> Start 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
>
> **handle** `string` *required*
>
> Consenting customer's phone number in E.164 format or email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Chat
>
> **Slug:** `LINQ_CREATE_CHAT`
>
> Create 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
>
> **message** `object` *required*
>
> Initial message for the new chat.
>
> **recipients** `array` *required*
>
> Recipient phone numbers in E.164 format or email addresses.
>
> **override\_optout** `boolean`
>
> Send this request despite an existing recipient opt-out. The opt-out remains in place and the override is audited.
>
> **from\_phone\_number** `string` *required*
>
> Authorized sender phone number in E.164 format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Payment
>
> **Slug:** `LINQ_CREATE_PAYMENT`
>
> Create 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
>
> **handle** `string` *required*
>
> Consenting customer's phone number in E.164 format or email address.
>
> **currency** `string` *required*
>
> Currency code for the payment.
>
> **merchant** `object`
>
> Optional merchant name and URL against which the virtual card is minted.
>
> **metadata** `object`
>
> Optional caller-owned string metadata echoed on the payment.
>
> **description** `string`
>
> Optional description of the purchase.
>
> **amount\_cents** `integer` *required*
>
> Payment amount in minor currency units.
>
> **idempotency\_key** `string`
>
> Optional stable key for safe retries of this exact payment request. Reuse the same key rather than creating a second financial operation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Payment Request
>
> **Slug:** `LINQ_CREATE_PAYMENT_REQUEST`
>
> Create 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
>
> **mode** `string ("payment" | "subscription")`
>
> payment collects once; subscription starts automatic recurring billing.
>
> **rail** `string ("stripe" | "natural")`
>
> stripe settles to the connected Stripe account; natural uses Natural custodial wallets.
>
> **amount** `integer`
>
> One-time amount in minor currency units; required only in payment mode.
>
> **currency** `string`
>
> ISO 4217 currency code; currently usd and required only in payment mode.
>
> **discount** `object`
>
> One Stripe coupon or promotion code for a subscription.
>
> **metadata** `object`
>
> Up to 49 correlation fields; keys beginning with linq\_ are reserved.
>
> **price\_id** `string`
>
> Active recurring Stripe Price ID; required only in subscription mode.
>
> **quantity** `integer`
>
> Subscription price quantity; Linq defaults it to 1 when omitted.
>
> **trial\_end** `string`
>
> Future ISO 8601 subscription trial-end timestamp; mutually exclusive with trial\_period\_days.
>
> **customer\_id** `string`
>
> Existing Stripe Customer ID on the connected account, when applicable.
>
> **description** `string`
>
> Description shown to the recipient at checkout.
>
> **payer\_handle** `string`
>
> Payer E.164 phone number; required for the natural rail.
>
> **idempotency\_key** `string`
>
> Key for safely retrying this creation without creating another payment request; reuse it only with identical parameters.
>
> **from\_phone\_number** `string`
>
> Organization-owned E.164 sending line; required for the natural rail.
>
> **trial\_period\_days** `integer`
>
> Subscription free-trial length in days; mutually exclusive with trial\_end.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Poll
>
> **Slug:** `LINQ_CREATE_POLL`
>
> Irreversibly 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
>
> **poll** `object` *required*
>
> Poll options and optional idempotency key.
>
> **chat\_id** `string` *required*
>
> Unique ID of the existing chat that receives the poll.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Webhook Subscription
>
> **Slug:** `LINQ_CREATE_WEBHOOK_SUBSCRIPTION`
>
> Create 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
>
> **target\_url** `string` *required*
>
> HTTPS URL where Linq sends webhook events.
>
> **phone\_numbers** `array`
>
> Optional E.164 sending-line filters. Omit or pass an empty list to receive events from all lines.
>
> **routing\_id\_header** `string`
>
> Optional header name used to carry the chat ID for routing. Ignored unless routing\_key\_header is set.
>
> **subscribed\_events** `array` *required*
>
> Event types to deliver. Use LIST\_WEBHOOK\_EVENTS to discover currently available values.
>
> **routing\_key\_header** `string`
>
> Optional header name used for Linq delivery-affinity routing tokens. This configures a header name, not a token value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Attachment
>
> **Slug:** `LINQ_DELETE_ATTACHMENT`
>
> Permanently delete a Linq attachment and its stored bytes.
>
> #### Input Parameters
>
> **attachment\_id** `string` *required*
>
> Unique identifier of the attachment to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Message
>
> **Slug:** `LINQ_DELETE_MESSAGE`
>
> Irreversibly 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
>
> **message\_id** `string` *required*
>
> Unique ID of the message record to delete from Linq.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook Subscription
>
> **Slug:** `LINQ_DELETE_WEBHOOK_SUBSCRIPTION`
>
> Permanently delete a Linq webhook subscription and stop its future event deliveries.
>
> #### Input Parameters
>
> **subscription\_id** `string` *required*
>
> Unique identifier of the webhook subscription to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Edit Message
>
> **Slug:** `LINQ_EDIT_MESSAGE`
>
> Irreversibly 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
>
> **text** `string` *required*
>
> Replacement text for the selected message part.
>
> **message\_id** `string` *required*
>
> Unique ID of the previously sent message to edit.
>
> **part\_index** `integer`
>
> Index of the message part to edit.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Attachment
>
> **Slug:** `LINQ_GET_ATTACHMENT`
>
> Return metadata and current status for a Linq attachment referenced by a message. This metadata-only action does not download the file.
>
> #### Input Parameters
>
> **attachment\_id** `string` *required*
>
> Attachment ID found in a message part.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Available Number
>
> **Slug:** `LINQ_GET_AVAILABLE_NUMBER`
>
> Select an available Linq sending number, optionally for recipients or a line type. Treat the returned vCard URL as sensitive and ephemeral.
>
> #### Input Parameters
>
> **type** `string ("RCS" | "iMessage")`
>
> Only select an RCS or iMessage sending line.
>
> **recipients** `array`
>
> Recipient E.164 numbers or emails used to make the line selection sticky to an existing matching chat.
>
> **exclude\_from** `array`
>
> E.164 sending lines to exclude from selection, up to 100 entries.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Chat
>
> **Slug:** `LINQ_GET_CHAT`
>
> Return one chat by ID, including participants, service, state, and health information.
>
> #### Input Parameters
>
> **chat\_id** `string` *required*
>
> Unique chat ID returned by LINQ\_LIST\_CHATS or a send action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Chat Location
>
> **Slug:** `LINQ_GET_CHAT_LOCATION`
>
> Return precise locations currently shared by contacts in a chat. Treat coordinates and addresses as sensitive and minimize retention.
>
> #### Input Parameters
>
> **chat\_id** `string` *required*
>
> Identifier of the chat whose actively shared locations should be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Experience
>
> **Slug:** `LINQ_GET_EXPERIENCE`
>
> Return one Linq experience and preserve its dynamic action field definitions. Discovery does not prove that required provider setup is complete.
>
> #### Input Parameters
>
> **experience** `string` *required*
>
> Experience key returned by LIST\_EXPERIENCES, such as agentpay.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Message
>
> **Slug:** `LINQ_GET_MESSAGE`
>
> Return one Linq message by ID with its content parts, sender, actual and preferred transport, delivery state, reply target, and timestamps.
>
> #### Input Parameters
>
> **message\_id** `string` *required*
>
> Unique message ID returned by a message list, send action, or webhook.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payment
>
> **Slug:** `LINQ_GET_PAYMENT`
>
> Read 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
>
> **payment\_id** `string` *required*
>
> Payment identifier returned by CREATE\_PAYMENT.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payment Credentials
>
> **Slug:** `LINQ_GET_PAYMENT_CREDENTIALS`
>
> Return 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
>
> **payment\_id** `string` *required*
>
> Ready payment identifier whose card-reveal handoff is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payment Handle Connection
>
> **Slug:** `LINQ_GET_PAYMENT_HANDLE_CONNECTION`
>
> Read 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
>
> **handle** `string` *required*
>
> Consenting customer's phone number in E.164 format or email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payment Provider
>
> **Slug:** `LINQ_GET_PAYMENT_PROVIDER`
>
> Read 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
>
> **provider** `string` *required*
>
> Payment-provider key, such as agentcard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Payment Request
>
> **Slug:** `LINQ_GET_PAYMENT_REQUEST`
>
> Return 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
>
> **payment\_request\_id** `string` *required*
>
> Unique payment-request ID returned by create or list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Poll
>
> **Slug:** `LINQ_GET_POLL`
>
> Return an iMessage poll's current options, voters, and distinct voter count.
>
> #### Input Parameters
>
> **message\_id** `string` *required*
>
> Poll-definition message ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reputation Audit
>
> **Slug:** `LINQ_GET_REPUTATION_AUDIT`
>
> Return a Linq line reputation audit created with explicit approval. Audits are retained for no more than 24 hours.
>
> #### Input Parameters
>
> **audit\_id** `string` *required*
>
> Audit identifier returned by START\_REPUTATION\_AUDIT.
>
> **phone\_number** `string` *required*
>
> Audited Linq sending line in E.164 format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webhook Subscription
>
> **Slug:** `LINQ_GET_WEBHOOK_SUBSCRIPTION`
>
> Return one Linq webhook subscription by ID, including its callback URL, event and phone filters, active state, and configured routing-header names.
>
> #### Input Parameters
>
> **subscription\_id** `string` *required*
>
> Unique identifier of the webhook subscription.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Leave Chat
>
> **Slug:** `LINQ_LEAVE_CHAT`
>
> Leave an iMessage group chat. This is irreversible and prevents further interaction through the sending line.
>
> #### Input Parameters
>
> **chat\_id** `string` *required*
>
> Unique identifier of the group chat to leave.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Blocked Handles
>
> **Slug:** `LINQ_LIST_BLOCKED_HANDLES`
>
> Return phone numbers, email addresses, short codes, and sender IDs currently blocked account-wide from inbound and direct outbound messaging.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Chats
>
> **Slug:** `LINQ_LIST_CHATS`
>
> Return one page of chats, optionally filtered by sending line or participant, with a cursor for the next page.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum chats to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous LIST\_CHATS response; omit for the first page.
>
> **participant** `string`
>
> Only return chats containing this participant phone number or email address.
>
> **from\_phone\_number** `string`
>
> Only return chats using this sender line in E.164 format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Contact Cards
>
> **Slug:** `LINQ_LIST_CONTACT_CARDS`
>
> Return Linq account contact-card identity data, optionally for one E.164 sending line.
>
> #### Input Parameters
>
> **phone\_number** `string`
>
> E.164 sending line to filter by. Omit to return all account contact cards.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Experiences
>
> **Slug:** `LINQ_LIST_EXPERIENCES`
>
> Discover Linq experiences and their dynamic action fields. Availability in this response does not prove payment-provider onboarding is complete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Messages
>
> **Slug:** `LINQ_LIST_MESSAGES`
>
> Return 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
>
> **limit** `integer`
>
> Maximum messages to return in this page (1-100).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous response; omit for the first page.
>
> **chat\_id** `string` *required*
>
> Chat whose messages to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Message Thread
>
> **Slug:** `LINQ_LIST_MESSAGE_THREAD`
>
> Return 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
>
> **limit** `integer`
>
> Maximum thread messages to return in this page (1-100).
>
> **order** `string ("asc" | "desc")`
>
> Sort messages oldest-first (asc) or newest-first (desc).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous response; omit for the first page.
>
> **message\_id** `string` *required*
>
> ID of any message in the thread.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payment Requests
>
> **Slug:** `LINQ_LIST_PAYMENT_REQUESTS`
>
> Return 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
>
> **limit** `integer`
>
> Maximum payment requests in this page (1-100).
>
> **cursor** `string`
>
> Opaque continuation cursor from a previous response; omit for the first page.
>
> **offset** `integer`
>
> Number of payment requests to skip on the first page.
>
> **status** `string ("requested" | "authorized" | "succeeded" | "canceled" | "expired" | "declined")`
>
> Optional lifecycle-status filter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Phone Numbers
>
> **Slug:** `LINQ_LIST_PHONE_NUMBERS`
>
> Return the connected Linq account's sending lines with line type, forwarding configuration, and reputation status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhook Events
>
> **Slug:** `LINQ_LIST_WEBHOOK_EVENTS`
>
> Return the webhook event types currently available for subscription on the connected Linq account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhook Subscriptions
>
> **Slug:** `LINQ_LIST_WEBHOOK_SUBSCRIPTIONS`
>
> Return the connected Linq account's webhook subscriptions, including event and phone-number filters, target URLs, active state, and routing-header names.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Chat As Read
>
> **Slug:** `LINQ_MARK_CHAT_AS_READ`
>
> Mark every message in a chat as read and send an irreversible read receipt.
>
> #### Input Parameters
>
> **chat\_id** `string` *required*
>
> Unique identifier of the chat to mark as read.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Chat Background
>
> **Slug:** `LINQ_REMOVE_CHAT_BACKGROUND`
>
> Reset a chat's recipient-visible transcript background to the default.
>
> #### Input Parameters
>
> **chat\_id** `string` *required*
>
> Unique identifier of the chat.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Chat Participant
>
> **Slug:** `LINQ_REMOVE_CHAT_PARTICIPANT`
>
> Queue removal of an external participant from a group chat. This changes recipient-visible conversation membership asynchronously.
>
> #### Input Parameters
>
> **handle** `string` *required*
>
> Phone number in E.164 format or email address of the participant to remove.
>
> **chat\_id** `string` *required*
>
> Unique identifier of the group chat.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Request Attachment Upload
>
> **Slug:** `LINQ_REQUEST_ATTACHMENT_UPLOAD`
>
> Reserve 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
>
> **filename** `string` *required*
>
> Name of the file to upload.
>
> **size\_bytes** `integer` *required*
>
> Size of the file in bytes, from 1 byte through 100 MiB.
>
> **content\_type** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Request Chat Location
>
> **Slug:** `LINQ_REQUEST_CHAT_LOCATION`
>
> Prompt 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
>
> **chat\_id** `string` *required*
>
> Identifier of the one-to-one iMessage chat whose contact should be prompted to share location.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Revoke Payment Handle Connection
>
> **Slug:** `LINQ_REVOKE_PAYMENT_HANDLE_CONNECTION`
>
> Irreversibly 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
>
> **handle** `string` *required*
>
> Customer phone number in E.164 format or email whose grant will be revoked.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Message
>
> **Slug:** `LINQ_SEND_MESSAGE`
>
> Send 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
>
> **parts** `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.
>
> **effect** `object`
>
> Optional iMessage screen or bubble effect.
>
> **reply\_to** `object`
>
> Optional threaded-reply target.
>
> **experience** `object`
>
> Single experience invocation sent as the whole message. Mutually exclusive with parts.
>
> **recipients** `array` *required*
>
> Recipient E.164 phone numbers or email addresses. One creates a direct chat; multiple create a group.
>
> **idempotency\_key** `string`
>
> Caller-generated key that prevents retries from sending twice.
>
> **excluded\_senders** `array`
>
> E.164 sender lines not to choose for a new chat. Existing matching chats can still be reused on an excluded line.
>
> **continuation\_text** `string`
>
> Replacement text sent only when Linq fails over an existing chat from a flagged line to a new line.
>
> **preferred\_service** `string ("iMessage" | "RCS" | "SMS")`
>
> Optional delivery preference. iMessage has no fallback; RCS and SMS use Linq's documented RCS-to-SMS behavior.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Message to Chat
>
> **Slug:** `LINQ_SEND_MESSAGE_TO_CHAT`
>
> Send 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
>
> **parts** `array`
>
> Ordered text, media, link, iMessage app, or App Clip parts. Mutually exclusive with experience.
>
> **effect** `object`
>
> Optional iMessage screen or bubble effect.
>
> **chat\_id** `string` *required*
>
> Existing chat that should receive the message.
>
> **reply\_to** `object`
>
> Optional target for a threaded reply.
>
> **experience** `object`
>
> Single experience invocation sent as the whole message. Mutually exclusive with parts.
>
> **idempotency\_key** `string`
>
> Caller-generated key that prevents a retry from sending twice.
>
> **preferred\_service** `string ("iMessage" | "SMS" | "RCS")`
>
> Preferred transport. iMessage has no fallback; RCS and SMS follow Linq's documented RCS-to-SMS behavior.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Voice Memo to Chat
>
> **Slug:** `LINQ_SEND_VOICE_MEMO_TO_CHAT`
>
> Irreversibly send recipient-visible audio as a native iMessage voice memo bubble to every participant in an existing Linq chat.
>
> #### Input Parameters
>
> **chat\_id** `string` *required*
>
> Unique identifier of the chat that will receive the voice memo.
>
> **attachment\_id** `string`
>
> ID of a voice-memo file pre-uploaded to Linq. Provide exactly one of attachment\_id or voice\_memo\_url.
>
> **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.
>
> **override\_optout** `boolean`
>
> Send despite the recipient's opt-out. The opt-out remains active and Linq records every override against the API key.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Chat Background
>
> **Slug:** `LINQ_SET_CHAT_BACKGROUND`
>
> Set a recipient-visible color, animated, or photo transcript background. Linq processes the change asynchronously.
>
> #### Input Parameters
>
> **type** `string ("color" | "dynamic" | "photo")` *required*
>
> Background family to apply.
>
> **style** `string ("sky" | "water" | "aurora")`
>
> Animated style for a dynamic background.
>
> **shades** `array`
>
> Two hexadecimal gradient stops for a custom color background.
>
> **chat\_id** `string` *required*
>
> Unique identifier of the chat.
>
> **variant** `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.
>
> **image\_url** `string`
>
> Fetchable HTTPS image URL for a photo background.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Up Contact Card
>
> **Slug:** `LINQ_SET_UP_CONTACT_CARD`
>
> Create or replace a Linq contact card for a sending line. This changes public account identity and may activate contact-card sharing.
>
> #### Input Parameters
>
> **image\_url** `string`
>
> Optional HTTPS profile image URL for the contact card.
>
> **last\_name** `string`
>
> Optional last name for the contact card.
>
> **first\_name** `string` *required*
>
> Required first name for the contact card.
>
> **phone\_number** `string` *required*
>
> E.164 sending line to associate with the contact card.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Share Contact Card With Chat
>
> **Slug:** `LINQ_SHARE_CONTACT_CARD_WITH_CHAT`
>
> Share the connected sending line's active contact card with a chat. This irreversibly discloses account identity to recipients.
>
> #### Input Parameters
>
> **chat\_id** `string` *required*
>
> Unique identifier of the chat that should receive the active contact card.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Payment Provider Onboarding
>
> **Slug:** `LINQ_START_PAYMENT_PROVIDER_ONBOARDING`
>
> Create 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
>
> **provider** `string` *required*
>
> Payment-provider key, such as agentcard.
>
> **return\_url** `string` *required*
>
> URL where Linq redirects the administrator after authorization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Reputation Audit
>
> **Slug:** `LINQ_START_REPUTATION_AUDIT`
>
> Start a potentially metered or limited reputation audit for a Linq sending line. The resulting audit persists for 24 hours.
>
> #### Input Parameters
>
> **phone\_number** `string` *required*
>
> Linq sending line to audit in E.164 format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Typing Indicator
>
> **Slug:** `LINQ_START_TYPING_INDICATOR`
>
> Show a best-effort recipient-visible typing indicator for about 85-90 seconds. Primarily effective for active iMessage chats.
>
> #### Input Parameters
>
> **chat\_id** `string` *required*
>
> Unique identifier of the chat.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Stop Chat Location Sharing
>
> **Slug:** `LINQ_STOP_CHAT_LOCATION_SHARING`
>
> Stop a specific contact's inbound location share. This consent-sensitive operation ends that contact's share across chats.
>
> #### Input Parameters
>
> **handle** `string` *required*
>
> Phone number in E.164 format or email address of the contact whose share should end.
>
> **chat\_id** `string` *required*
>
> Identifier of the chat whose inbound location share should be ended.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Stop Typing Indicator
>
> **Slug:** `LINQ_STOP_TYPING_INDICATOR`
>
> Immediately clear the connected line's recipient-visible typing indicator for a chat.
>
> #### Input Parameters
>
> **chat\_id** `string` *required*
>
> Unique identifier of the chat.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Toggle Poll Vote
>
> **Slug:** `LINQ_TOGGLE_POLL_VOTE`
>
> Irreversibly send a recipient-visible update that adds or removes the connected line's vote on one option of an iMessage poll.
>
> #### Input Parameters
>
> **operation** `string ("add" | "remove")` *required*
>
> Add or remove the connected line's vote on the option.
>
> **option\_id** `string` *required*
>
> Unique ID of the option whose vote will be toggled.
>
> **message\_id** `string` *required*
>
> Poll-definition message ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unblock Handle
>
> **Slug:** `LINQ_UNBLOCK_HANDLE`
>
> Remove an account-wide messaging block. This changes messaging behavior; for testing, unblock only a handle blocked by the same test.
>
> #### Input Parameters
>
> **handle** `string` *required*
>
> Account-wide blocked handle to unblock.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Chat
>
> **Slug:** `LINQ_UPDATE_CHAT`
>
> Update a group chat's display name or icon. The participant-visible change is processed asynchronously.
>
> #### Input Parameters
>
> **chat\_id** `string` *required*
>
> Unique identifier of the chat.
>
> **display\_name** `string`
>
> New display name for the group chat.
>
> **group\_chat\_icon** `string`
>
> Image URL to set as the group chat icon.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Contact Card
>
> **Slug:** `LINQ_UPDATE_CONTACT_CARD`
>
> Update the public contact-card identity for one Linq sending line.
>
> #### Input Parameters
>
> **image\_url** `string`
>
> Updated profile image URL. Omit to preserve the existing image.
>
> **last\_name** `string`
>
> Updated last name. Omit to preserve the existing value.
>
> **first\_name** `string`
>
> Updated first name. Omit to preserve the existing value.
>
> **phone\_number** `string` *required*
>
> E.164 sending line whose contact card should be updated.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update iMessage App Card
>
> **Slug:** `LINQ_UPDATE_IMESSAGE_APP_CARD`
>
> Irreversibly 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
>
> **app** `object`
>
> Original app identity. Required for a raw URL update on a zero-day-retention line; ignored for an experience update.
>
> **url** `string`
>
> New card destination URL. Mutually exclusive with experience.
>
> **layout** `object` *required*
>
> Visible layout of the updated card.
>
> **experience** `object`
>
> Experience action that builds the card. Mutually exclusive with url.
>
> **message\_id** `string` *required*
>
> ID of the original app-card message or its most recent update.
>
> **interactive** `boolean`
>
> Whether installed extensions render an interactive balloon.
>
> **fallback\_text** `string`
>
> Text shown on surfaces that cannot render the updated card.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Message Reaction
>
> **Slug:** `LINQ_UPDATE_MESSAGE_REACTION`
>
> Irreversibly mutate recipient-visible reaction state by adding or removing a tapback, or by adding an iMessage sticker. Stickers cannot be removed.
>
> #### Input Parameters
>
> **url** `string`
>
> Linq-hosted HTTPS sticker URL; valid only when type is sticker.
>
> **type** `string ("love" | "like" | "dislike" | "laugh" | "emphasize" | "question" | "custom" | "sticker")` *required*
>
> Standard tapback, custom tapback, or sticker type.
>
> **emoji** `string`
>
> Emoji sticker source; valid only when type is sticker.
>
> **operation** `string ("add" | "remove")` *required*
>
> Whether to add or remove the reaction.
>
> **placement** `object`
>
> Optional sticker position, size, and rotation.
>
> **message\_id** `string` *required*
>
> Unique ID of the message to react to.
>
> **part\_index** `integer`
>
> Optional index of the message part to react to.
>
> **custom\_emoji** `string`
>
> Tapback emoji; required only when type is custom.
>
> **attachment\_id** `string`
>
> Pre-uploaded sticker attachment ID; valid only when type is sticker.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Phone Number
>
> **Slug:** `LINQ_UPDATE_PHONE_NUMBER`
>
> Change a Linq sending line's production forwarding configuration. Capture the current value before changing it when rollback is required.
>
> #### Input Parameters
>
> **phone\_number\_id** `string` *required*
>
> UUID of the Linq sending line to update.
>
> **forwarding\_number** `string` *required*
>
> Forwarding number in E.164 format. Send null or an empty string to clear it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Sticker Placement
>
> **Slug:** `LINQ_UPDATE_STICKER_PLACEMENT`
>
> Irreversibly send a recipient-visible update that moves, resizes, or rotates an existing iMessage sticker on a message.
>
> #### Input Parameters
>
> **placement** `object` *required*
>
> Sticker placement fields to change; omitted fields keep their current values.
>
> **message\_id** `string` *required*
>
> ID of the message on which the sticker is placed.
>
> **reaction\_id** `string` *required*
>
> ID of the sticker reaction to move.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Webhook Subscription
>
> **Slug:** `LINQ_UPDATE_WEBHOOK_SUBSCRIPTION`
>
> Update a Linq webhook subscription's callback, filters, active state, or routing-header names. Callback and routing changes can redirect future account events.
>
> #### Input Parameters
>
> **is\_active** `boolean`
>
> Set whether delivery is active. Omit to preserve the current state.
>
> **target\_url** `string`
>
> New HTTPS callback URL. Omit to leave the callback unchanged.
>
> **phone\_numbers** `array`
>
> Replacement E.164 filters. Pass an empty list or null to receive events from all lines; omit to leave filters unchanged.
>
> **subscription\_id** `string` *required*
>
> Unique identifier of the webhook subscription.
>
> **routing\_id\_header** `string`
>
> Replacement chat-ID header name. Pass null or an empty string to use Linq-Chat-Id; omit to leave it unchanged.
>
> **subscribed\_events** `array`
>
> Replacement event list. Omit to leave subscribed events unchanged.
>
> **routing\_key\_header** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Verify Payment Handle
>
> **Slug:** `LINQ_VERIFY_PAYMENT_HANDLE`
>
> Submit 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
>
> **code** `string` *required*
>
> Single-use, short-lived one-time code received by the customer.
>
> **handle** `string` *required*
>
> Consenting customer's phone number in E.164 format or email address.
>
> **connect\_id** `string` *required*
>
> Transient connection ID returned by CONNECT\_PAYMENT\_HANDLE.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
