Account & plan

The accounts this connection can use (LinkedIn, WhatsApp, Telegram, Instagram, Instagram Business, Facebook Messenger, and publishing accounts), with their account_id, provider, name, status and what each can do (can). Pass account_id as `account` to any tool when more than one account could do what it does. Start here when you don't know what's connected. instagram is an account connected with its login (all its DMs, starting conversations, profiles); instagrambusiness a Business or Creator account on Instagram's official access (replies within Instagram's windows, comments, insights, posts).

{
  "accounts": [
    {
      "account_id": "3f2b8c1e-7a4d-4e9b-9c21-5d8e6f0a1b2c",
      "provider": "linkedin",
      "name": "Ada Martin",
      "status": "running",
      "can": [
        "chats",
        "start_chat",
        "profiles",
        "posts",
        "people_search",
        "invitations"
      ]
    },
    {
      "account_id": "8d41a7f0-2c6e-4b1a-a3d9-71e5c0b4f826",
      "provider": "whatsapp",
      "name": "+33 6 12 34 56 78",
      "status": "running",
      "can": [
        "chats",
        "start_chat",
        "profiles",
        "groups",
        "reactions"
      ]
    }
  ]
}

Status and limits of one connected account, any network. Call before planning several actions. Says whether the account can act now (blocked_reason), how many actions are left today (messages → send_message, new_conversations → start_chat, profile_views → get_profile, posts → create_post; on LinkedIn also searches → linkedin_search_people and invitations → linkedin_send_invitation, with a weekly limit too; on Facebook friend requests and follows), and ready_in_seconds for each: the wait before that action can run. Reading has a high limit and is not listed. No account or a disconnected one: use connect_account. Plan or seats: use pluggzy_billing.

{
  "account_id": "8d41a7f0-2c6e-4b1a-a3d9-71e5c0b4f826",
  "provider": "whatsapp",
  "status": "running",
  "blocked_reason": null,
  "plan": "pro",
  "next_action_in_seconds": 0,
  "limits": {
    "profile_views": {
      "used_today": 2,
      "limit_today": 50,
      "left_today": 48,
      "ready_in_seconds": 0
    },
    "messages": {
      "used_today": 14,
      "limit_today": 100,
      "left_today": 86,
      "ready_in_seconds": 0
    },
    "new_conversations": {
      "used_today": 1,
      "limit_today": 10,
      "left_today": 9,
      "ready_in_seconds": 0
    }
  },
  "daily_reset_in_seconds": 40260,
  "weekly_reset_in_seconds": 299460
}

Get a link for the user to connect a LinkedIn, WhatsApp, Telegram, Instagram, Facebook or Messenger account (Messenger and Facebook are one login: it brings Messenger, the profile and the Pages it manages, billed once), or to reconnect one that was logged out. Before giving the link, tell the user what the result says about the free trial or price. Publishing accounts can be connected too: Threads, TikTok, YouTube, Pinterest, Google Business Profile, WordPress, Instagram Business. Instagram comes two ways: instagram connects any account with its login (all its DMs, starting conversations, profiles); instagrambusiness connects a Business or Creator account through Instagram's official access, no password shared (replies to DMs within Instagram's windows, comments, insights, posts and Reels), the steadier choice for a professional account. They log in on our connect page in their browser (LinkedIn, Instagram and Facebook: their login; WhatsApp and Telegram: scan a QR code; Threads, TikTok, YouTube, Pinterest, Google Business Profile, WordPress, Instagram Business: they approve access on the network's own page). Never ask for passwords or codes in the chat. The link works for 30 minutes. Afterwards, call list_accounts to confirm.

{
  "url": "https://pluggzy.com/go/connect?t=eyJwIjoiY29ubmVjdCIsImV4cCI6MTc2MjY4MDAwMH0.k3Qm8ZrT0vX2bN5pL7wY1cA4dF6gH9jE",
  "provider": "whatsapp",
  "mode": "new",
  "expires_in_minutes": 30
}

The user's Pluggzy plan: free trial or subscription (one price per connected account per month, any provider, in the user's regional currency), with a link to our billing page to subscribe, update their card, get invoices, or cancel (payment happens on Stripe, in their browser). The link works for 30 minutes. Use it when the tools say the trial or subscription ended.

{
  "billing_enabled": true,
  "plan": "pro",
  "active": true,
  "subscription_status": "active",
  "linkedin_accounts": 2,
  "price_per_account_month": 10,
  "currency": "USD",
  "url": "https://pluggzy.com/go/billing?t=eyJwIjoiY29ubmVjdCIsImV4cCI6MTc2MjY4MDAwMH0.k3Qm8ZrT0vX2bN5pL7wY1cA4dF6gH9jE",
  "expires_in_minutes": 30
}

Returns a link where the user uploads an image, a video or a document from their device, and the media_id to pass to create_post (media_ids), comment or a message (send_message, start_chat: media_id). Use it when the user wants a photo, video or document (a PDF, say) in a post or message and it isn't already online: files attached in the chat can't reach Pluggzy, so ask them to upload it here. If you made the file yourself in a sandbox or terminal with internet access, upload it yourself with the upload_command it returns. Images: JPEG, PNG or WebP, at most 8 MB. Videos: MP4, MOV or WebM, at most 5 GB on the page (upload_command sends at most 100 MB), for create_post on publishing accounts only (LinkedIn, Instagram, Facebook posts, comments and messages take images). Documents (PDF, Word, Excel, PowerPoint (docx, xlsx, pptx, doc, xls, ppt), TXT or CSV, at most 15 MB) for send_message and start_chat only. Each link takes one file: for another one (each image of a carousel, say), call upload_media again. The file can be used for 24 hours, in as many posts and messages as needed; a scheduled post keeps its own copy until it goes out.

{
  "url": "https://pluggzy.com/go/upload?t=eyJwIjoiY29ubmVjdCIsImV4cCI6MTc2MjY4MDAwMH0.k3Qm8ZrT0vX2bN5pL7wY1cA4dF6gH9jE",
  "media_id": "9b7d5f3a-1c2e-4a6b-8d0f-2e4c6a8b0d19",
  "upload_command": "curl -sS -T FILE_PATH -H 'X-File-Name: FILE_NAME' 'https://pluggzy.com/go/upload?t=eyJwIjoiY29ubmVjdCIsImV4cCI6MTc2MjY4MDAwMH0.k3Qm8ZrT0vX2bN5pL7wY1cA4dF6gH9jE'",
  "expires_in_minutes": 30,
  "usable_for_hours": 24,
  "max_image_mb": 8,
  "max_video_mb": 5000,
  "max_document_mb": 15
}

Search LinkedIn people by keywords. Returns ids usable with fetch.

{
  "results": [
    {
      "id": "person:ACoAAA8BYqEBCVM2yBH2uI6u",
      "title": "Ada Martin — VP Sales at Northwind Traders",
      "url": "https://www.linkedin.com/in/ada-martin-4b2a1c"
    }
  ]
}

Read a LinkedIn person:<id> returned by search, or a known chat:<chat_id> returned by list_chats. Use search with query keywords to find up to 10 people.

{
  "id": "person:ACoAAA8BYqEBCVM2yBH2uI6u",
  "title": "Ada Martin",
  "text": "VP Sales at Northwind Traders\nParis, Île-de-France, France\nBuilding sales teams that customers like talking to.\nVP Sales @ Northwind Traders (3/2022–present)",
  "url": "https://www.linkedin.com/in/ada-martin-4b2a1c",
  "metadata": {
    "degree": "SECOND_DEGREE"
  }
}