Unipile

# Unipile Documentation

## Guides
- [Connection methods](https://developer.unipile.com/docs/connect-accounts.md): Before you can handle chats and messages, you must connect an account of the wanted messaging provider. Discover Unipile's connection methods in this section.
- [Hosted auth wizard](https://developer.unipile.com/docs/hosted-auth.md): Learn how to use Hosted Auth Wizard to connect accounts on your application.
- [IMAP Guide](https://developer.unipile.com/docs/imap-guide.md): Learn how to implement a custom IMAP authentication form into your application. Find the [Developper IMAP API Guide](https://www.unipile.com/the-developers-guide-to-imap-api-solution/)
- [Custom authentication](https://developer.unipile.com/docs/native-auth.md): Learn how you can implement a custom authentication to connect accounts on your application.
- [Instagram Guide](https://developer.unipile.com/docs/instagram.md): Learn how to implement a custom Instagram authentication form into your application.
- [LinkedIn Guide](https://developer.unipile.com/docs/linkedin.md): Learn how to implement a custom LinkedIn authentication form into your application.
- [Messenger Guide](https://developer.unipile.com/docs/messenger.md): Learn how to implement a custom Messenger authentication form into your application.
- [Telegram Guide](https://developer.unipile.com/docs/telegram.md): Learn how to implement a custom Telegram authentication form into your application.
- [X (Twitter) Guide](https://developer.unipile.com/docs/twitter-x-guide.md): Learn how to implement a custom X - Twitter authentication form into your application.
- [WhatsApp Guide](https://developer.unipile.com/docs/whatsapp.md): Learn how to implement a custom WhatsApp authentication form into your application.
- [Retrieving messages](https://developer.unipile.com/docs/get-messages.md): Learn how to retrieve messages of your connected accounts.
- [Message object](https://developer.unipile.com/docs/message-payload.md): This section will explain in detail each field of the message object so you can properly integrate them in your application
- [Send Messages](https://developer.unipile.com/docs/send-messages.md): Learn how to send messages with Unipile
- [Calendars & Events](https://developer.unipile.com/docs/calendars-and-events.md): Learn how to manage calendars & events of your connected accounts.
- [Email object](https://developer.unipile.com/docs/email-object.md): This section will explain in detail each field of the email object so you can properly integrate them in your application
- [Google OAuth](https://developer.unipile.com/docs/google-oauth.md)
- [Email & Calendars overview](https://developer.unipile.com/docs/emails.md)
- [Microsoft OAuth](https://developer.unipile.com/docs/microsoft-oauth.md)
- [Retrieving emails](https://developer.unipile.com/docs/retrieving-emails.md): Learn how to retrieve messages of your connected accounts.
- [Send Email](https://developer.unipile.com/docs/send-email.md): Learn how to send messages with Unipile
- [API Usage](https://developer.unipile.com/docs/api-usage.md)
- [Dev Tools](https://developer.unipile.com/docs/dev-tools.md): Explore SDK options and no-code solutions for seamless integration with our platform, including Node.js SDK and n8n setup guides.
- [MCP](https://developer.unipile.com/docs/mcp.md)
- [Create webhook n8n](https://developer.unipile.com/docs/create-webhook-n8n.md)
- [Create request from n8n](https://developer.unipile.com/docs/createpost-request-n8n.md): With n8n, you can easily integrate Unipile API requests into your workflows. A request can be made using POST or GET, depending on the endpoint and the data you want to send or retrieve.  In this tutorial, we will show how to configure the HTTP Request node to call different Unipile’s endpoint and send the required parameters (account, text, and optional attachments).  These requests can be used as standalone actions or integrated into more complex workflows, combined with other nodes such as databases, schedulers, or third-party services.  This way, you can fully automate content publishing and other actions supported by Unipile’s API directly inside n8n.
- [Examples n8n Workflows](https://developer.unipile.com/docs/example-workflow-n8n.md): This section provides ready-to-use n8n workflows showcasing how to interact with the Unipile API to automate various tasks such as messaging, data retrieval, content posting, and more.  These examples are designed to help you quickly integrate Unipile into your automation flows, whether you're a developer, technical user, or exploring advanced use cases. Each workflow is provided as a JSON file that you can import into your n8n instance and adapt to your specific needs.                           📌 Note: Be sure to replace placeholder values like X-API-KEY, account_id, etc., with your actual credentials, and secure your webhooks as needed.
- [n8n Integration](https://developer.unipile.com/docs/n8n.md): This section of the documentation explains how to integrate Unipile’s API with n8n, an open-source workflow automation tool. With n8n, you can easily connect Unipile to external services (email, CRM, LinkedIn, WhatsApp, Instagram, etc.), automate repetitive tasks, and build advanced workflows without writing complex code.
- [Node.js SDK](https://developer.unipile.com/docs/nodejs-sdk.md): A Node.js wrapper for API to manage messaging, mail and calendars.
- [Getting Started](https://developer.unipile.com/docs/getting-started.md)
- [List of provider features](https://developer.unipile.com/docs/list-provider-features.md)
- [Provider Limits and Restrictions](https://developer.unipile.com/docs/provider-limits-and-restrictions.md)
- [Detecting Accepted Invitations](https://developer.unipile.com/docs/detecting-accepted-invitations.md): Learn how to identify when a user accepts your LinkedIn invitation, enabling you to initiate subsequent actions.
- [Get Raw Data Route Example](https://developer.unipile.com/docs/get-raw-data-example.md): Learn how to use Magic  Route
- [How to create an Outreach Sequence](https://developer.unipile.com/docs/how-to-create-outreach-sequence.md)
- [Perform API Linkedin search and export result](https://developer.unipile.com/docs/linkedin-search.md)
- [Posts and Comments](https://developer.unipile.com/docs/posts-and-comments.md)
- [Invite users](https://developer.unipile.com/docs/invite-users.md)
- [Retrieving users](https://developer.unipile.com/docs/retrieving-users.md)
- [Users overview](https://developer.unipile.com/docs/users-overview.md)
- [Account status updates](https://developer.unipile.com/docs/account-lifecycle.md): Learn how to handle account status.
- [Calendar webhook](https://developer.unipile.com/docs/calendar-webhook.md): Unipile can notify your server in real time when a calendar event is created, updated, or deleted.  Calendar webhooks allow you to synchronize events, trigger automation workflows, or maintain a local cache of calendar data without polling.
- [New email](https://developer.unipile.com/docs/new-emails-webhook.md): Get real-time updates on new email using Unipile's Webhook.
- [New messages](https://developer.unipile.com/docs/new-messages-webhook.md): Get real-time updates on new messages using Unipile's Webhook.
- [Tracking email](https://developer.unipile.com/docs/tracking-email.md): Get real-time click and open  on sent email using Unipile's Webhook.
- [Webhooks overview](https://developer.unipile.com/docs/webhooks-2.md)

## API Reference
- [Connect an account (native authentication)](https://developer.unipile.com/reference/accountscontroller_createaccount.md): Link to Uniple an account of the given type and provider.
- [Delete an account](https://developer.unipile.com/reference/accountscontroller_deleteaccount.md): Unlink the given account to Unipile.
- [Retrieve an account](https://developer.unipile.com/reference/accountscontroller_getaccountbyid.md): Retrieve the details of an account.
- [List all accounts](https://developer.unipile.com/reference/accountscontroller_listaccounts.md): Returns a list of the accounts linked to Unipile.
- [Update account proxy](https://developer.unipile.com/reference/accountscontroller_patchaccount.md): Update the proxy configuration of an existing account. You can provide a custom proxy, or request a new Unipile proxy by country/IP.
- [Reconnect an account](https://developer.unipile.com/reference/accountscontroller_reconnectaccount.md): Reconnect an account previously linked to Unipile that has been disconnected.
- [Resend checkpoint notification](https://developer.unipile.com/reference/accountscontroller_resendcheckpoint.md): Might it be 2FA, OTP or In-app Validation, this route makes you able on certain providers to resend the notification.
- [Restart an account](https://developer.unipile.com/reference/accountscontroller_restartaccount.md): Restart the sources of a frozen account.
- [Resynchronize account messaging data](https://developer.unipile.com/reference/accountscontroller_resyncaccount.md): This route can be used both to initiate a sync process (from scratch of within a specific time span) and to monitor its status via regular polling. Supported providers : Linkedin.
- [Solve a code checkpoint](https://developer.unipile.com/reference/accountscontroller_solvecheckpoint.md): Allows you to provide a code which will solve a checkpoint encountered during a native authentication. A checkpoint is a security step added by a provider which needs to be solved to complete the authentication. Checkpoints that require a code are 2FA (two-factor authentication) and OTP (one-time password). Depending on the way you have configured the account you are trying to authenticate, you can get your code from various ways such as a mail, a SMS or from a two-factor authentication app.
- [Connect an account (hosted authentication)](https://developer.unipile.com/reference/hostedcontroller_requestlink.md): Create a url which redirect to Unipile's hosted authentication to connect or reconnect an account.
- [Create an event](https://developer.unipile.com/reference/calendarscontroller_createcalendarevent.md): Create a calendar event.
- [Delete an event](https://developer.unipile.com/reference/calendarscontroller_deletecalendarevent.md): Delete a calendar event.
- [Edit an event](https://developer.unipile.com/reference/calendarscontroller_editcalendarevent.md): Edit a calendar event.
- [Retrieve a calendar](https://developer.unipile.com/reference/calendarscontroller_getcalendar.md): Retrieve the details of a calendar.
- [Retrieve an event](https://developer.unipile.com/reference/calendarscontroller_getcalendarevent.md): Retrieve the details of a calendar event.
- [Retrieve all events from a calendar](https://developer.unipile.com/reference/calendarscontroller_listcalendareventsbycalendar.md): Returns a list of calendar events related to the given calendar.
- [List all calendars](https://developer.unipile.com/reference/calendarscontroller_listcalendars.md): Returns a list of calendars.
- [Create a draft](https://developer.unipile.com/reference/draftscontroller_createdraft.md): ⚠️ Interactive documentation does not work on this route (child parameters not correctly applied in snippet), Create a new draft.
- [Retrieve a folder](https://developer.unipile.com/reference/folderscontroller_getfolder.md): Retrieve the details of a mail folder.
- [List all folders](https://developer.unipile.com/reference/folderscontroller_listfolders.md): Returns a list of all email folders.
- [Delete an email](https://developer.unipile.com/reference/mailscontroller_deletemail.md): Delete an email by moving it to the Trash folder.
- [Retrieve an attachment from an email](https://developer.unipile.com/reference/mailscontroller_getattachment.md): Retrieve one of the attachment linked to an email.
- [Retrieve an email](https://developer.unipile.com/reference/mailscontroller_getmail.md): Retrieve the details of an email.
- [List email contacts](https://developer.unipile.com/reference/mailscontroller_listcontacts.md): Returns a list of contacts from the email provider. Supported for Gmail (Google OAuth) and Microsoft (Outlook) only.
- [List all emails](https://developer.unipile.com/reference/mailscontroller_listmails.md): Returns a list of emails.
- [Send an email](https://developer.unipile.com/reference/mailscontroller_sendmail.md): ⚠️ Interactive documentation does not work on this route (child parameters not correctly applied in snippet), please use our ready to copy past example of this page : https://developer.unipile.com/docs/send-email
- [Update an email](https://developer.unipile.com/reference/mailscontroller_updatemail.md): Update an email.
- [Close a job posting](https://developer.unipile.com/reference/linkedincontroller_closejobposting.md): Close a job offer you have posted.
- [Create a job posting](https://developer.unipile.com/reference/linkedincontroller_createjobposting.md): Create a new job offer draft.
- [Edit a job posting](https://developer.unipile.com/reference/linkedincontroller_editjobposting.md): Edit an existing job posting.
- [Endorse a user profile specific skill](https://developer.unipile.com/reference/linkedincontroller_endorseprofile.md): This route can be used to endorse a skill of a user profile.
- [Retrieve a company profile](https://developer.unipile.com/reference/linkedincontroller_getcompanyprofile.md): Get a company profile from its name or ID.
- [Retrieve Recruiter hiring project from ID](https://developer.unipile.com/reference/linkedincontroller_gethiringprojectbyid.md): Retrieve a particular hiring project.
- [Retrieve Recruiter hiring projects](https://developer.unipile.com/reference/linkedincontroller_gethiringprojects.md): Retrieve list of LinkedIn Recruiter hiring projects.
- [Get inmail credit balance](https://developer.unipile.com/reference/linkedincontroller_getinmailbalance.md): Get balance for subscribed premium features.
- [Get a specific applicant to a job posting](https://developer.unipile.com/reference/linkedincontroller_getjobapplicant.md): Retrieve the details of a user that has applied to a given offer. Applies to Classic job posting only.
- [Download the resume of a job applicant](https://developer.unipile.com/reference/linkedincontroller_getjobapplicantresume.md): This route can be used to download the resume of a job applicant.
- [List all applicants to a job posting](https://developer.unipile.com/reference/linkedincontroller_getjobapplicants.md): Retrieve all the users that have applied to a given offer.
- [Get job offer](https://developer.unipile.com/reference/linkedincontroller_getjobposting.md): Retrieve a job offer.
- [List all job postings](https://developer.unipile.com/reference/linkedincontroller_getjobpostings.md): Retrieve the job offers you have posted on LinkedIn whether they are open, closed or still drafts.
- [Get raw data from any endpoint](https://developer.unipile.com/reference/linkedincontroller_getrawdata.md): This magic route is intended for advanced users who wish to use LinkedIn's features beyond our current capabilities. It enables you to create custom functionalities that are not yet supported by our platform, using connected accounts. To utilize this route, you will need to identify the specific endpoint containing the desired data using web developer tools on LinkedIn, and then copy the URL along with its parameters for implementation.
- [Retrieve LinkedIn search parameters](https://developer.unipile.com/reference/linkedincontroller_getsearchparameterslist.md): LinkedIn doesn't accept raw text as search parameters, but IDs. This route will help you get the right IDs for your inputs. Check out our Guide with examples to master LinkedIn search : https://developer.unipile.com/docs/linkedin-search
- [Perform an action with a user profile](https://developer.unipile.com/reference/linkedincontroller_performactiononmember.md): Add a candidate to a Recruiter pipeline, save a Sales Navigator lead, etc.
- [Publish a job posting](https://developer.unipile.com/reference/linkedincontroller_publishjobposting.md): Publish the job posting draft you have been working on.
- [Perform Linkedin search](https://developer.unipile.com/reference/linkedincontroller_search.md): Search people and companies from the Linkedin Classic as well as Sales Navigator APIs. Check out our Guide with examples to master LinkedIn search : https://developer.unipile.com/docs/linkedin-search
- [Solve a job publishing checkpoint](https://developer.unipile.com/reference/linkedincontroller_solvecheckpoint.md): Solve a checkpoint to verify your member privilegies.
- [Retrieve an attendee](https://developer.unipile.com/reference/chatattendeescontroller_getattendeebyid.md): The id of the wanted attendee.
- [Download a chat attendee picture](https://developer.unipile.com/reference/chatattendeescontroller_getattendeeprofilepicture.md): Download the profile picture of an attendee or picture of a group chat.
- [List all attendees](https://developer.unipile.com/reference/chatattendeescontroller_listallattendees.md): Returns a list of messaging attendees. Some optional parameters are available to filter the results.