Linq icon

Linq

Interact with Linq API (community-built; not affiliated with Linq App Inc.)

Chat → Create

AI-generated

Summary

Create a new chat and optionally send an initial message with attachments, links, or effects.

Inputs

  • sendFrom (required) — Phone number to send from (E.164 format).
  • displayName — Display name for the chat.
  • phoneNumbers — Comma-separated list of recipient phone numbers or email addresses.
  • messageText — Text content of the message to send.
  • attachmentUrls — Comma-separated list of attachment URLs to include as media parts.
  • attachmentIds — Comma-separated list of pre‑uploaded attachment IDs to include as media parts.
  • linkUrl — Optional rich link preview URL; must be the only message part when provided.
  • preferredService — Preferred messaging service (Default, iMessage, RCS, SMS).
  • effectType — Optional iMessage effect type (screen, bubble, etc.).
  • effectName — Optional effect name such as confetti, fireworks, slam, etc.
  • replyToMessageId — Optional message ID to reply to.
  • replyToPartIndex — Optional part index for threaded replies.
  • idempotencyKey — Optional idempotency key to prevent duplicate message creation.

Output shape

a created chat resource (including its ID and metadata)

Success returns the full chat object; if a displayName was provided, a follow‑up update may be required; errors raise ApplicationError.

Examples

Example 1: Create a chat with two recipients and send an initial text message.

Set Send From, Phone Numbers, Message Text; operation = Create; resource = Chat.

Example 2: Create a chat and attach an image URL and a rich link preview.

Provide Attachment URLs and Link URL (must be sole part); operation = Create; resource = Chat.

Example 3: Create a chat, add an iMessage effect, and optionally reply to an existing message.

Set Effect Type, Effect Name, optionally Reply To Message ID; operation = Create; resource = Chat.

Links

Discussion