Unipile

Delete an account. DELETE https://{subdomain}.unipile.com:{port}/api/v1/accounts/{id}. Unlink the given account to Unipile.

Delete an event. DELETE https://{subdomain}.unipile.com:{port}/api/v1/calendars/{calendar_id}/events/{event_id}. Delete a calendar event.

Delete a chat. DELETE https://{subdomain}.unipile.com:{port}/api/v1/chats/{chat_id}. Delete a chat. Supported for WhatsApp and LinkedIn only.

Delete an email. DELETE https://{subdomain}.unipile.com:{port}/api/v1/emails/{email_id}. Delete an email by moving it to the Trash folder.

Delete a message. DELETE https://{subdomain}.unipile.com:{port}/api/v1/messages/{message_id}. Delete a message. Supported for WhatsApp and LinkedIn only. For LinkedIn, it is only possible within the first 60 minutes after the message is sent.

Cancel an invitation. DELETE https://{subdomain}.unipile.com:{port}/api/v1/users/invite/sent/{invitation_id}. Cancel a pending invitation sent to someone. Instagram: You can also use this route to unfollow users you have previously followed.

Delete a webhook. DELETE https://{subdomain}.unipile.com:{port}/api/v1/webhooks/{id}. Delete a webhook.

List all accounts. GET https://{subdomain}.unipile.com:{port}/api/v1/accounts. Returns a list of the accounts linked to Unipile.

Resynchronize account messaging data. GET https://{subdomain}.unipile.com:{port}/api/v1/accounts/{account_id}/sync. This route can be used both to initiate a sync process (from scratch or within a specific time span) and to monitor its status via regular polling. Supported providers: LinkedIn and Telegram. Instagram and WhatsApp are not supported by this route.

Retrieve an account. GET https://{subdomain}.unipile.com:{port}/api/v1/accounts/{id}. Retrieve the details of an account.

List all calendars. GET https://{subdomain}.unipile.com:{port}/api/v1/calendars. Returns a list of calendars.

Retrieve a calendar. GET https://{subdomain}.unipile.com:{port}/api/v1/calendars/{calendar_id}. Retrieve the details of a calendar.

Retrieve all events from a calendar. GET https://{subdomain}.unipile.com:{port}/api/v1/calendars/{calendar_id}/events. Returns a list of calendar events related to the given calendar.

Retrieve an event. GET https://{subdomain}.unipile.com:{port}/api/v1/calendars/{calendar_id}/events/{event_id}. Retrieve the details of a calendar event.

List all attendees. GET https://{subdomain}.unipile.com:{port}/api/v1/chat_attendees. Returns a list of messaging attendees. Some optional parameters are available to filter the results.

List all 1to1 chats for a given attendee. GET https://{subdomain}.unipile.com:{port}/api/v1/chat_attendees/{attendee_id}/chats. Returns a list of chats where a given attendee is involved.

Resynchronize chats for a given attendee. GET https://{subdomain}.unipile.com:{port}/api/v1/chat_attendees/{attendee_id}/sync. Starts or monitors the synchronization of all chats for a given attendee.

Retrieve an attendee. GET https://{subdomain}.unipile.com:{port}/api/v1/chat_attendees/{id}. The id of the wanted attendee.

Download a chat attendee picture. GET https://{subdomain}.unipile.com:{port}/api/v1/chat_attendees/{id}/picture. Download the profile picture of an attendee or picture of a group chat.

List all messages for a given attendee. GET https://{subdomain}.unipile.com:{port}/api/v1/chat_attendees/{sender_id}/messages. Returns a list of messages where a given attendee is involved.

List all chats. GET https://{subdomain}.unipile.com:{port}/api/v1/chats. Returns a list of chats. Some optional parameters are available to filter the results.

Retrieve a chat. GET https://{subdomain}.unipile.com:{port}/api/v1/chats/{chat_id}. Retrieve the details of a chat.

List all attendees from a chat. GET https://{subdomain}.unipile.com:{port}/api/v1/chats/{chat_id}/attendees. Returns a list of messaging attendees related to a given chat. Some optional parameters are available to filter the results.

List all messages from a chat. GET https://{subdomain}.unipile.com:{port}/api/v1/chats/{chat_id}/messages. Returns a list of messages related to the given chat. Some parameters are available to filter the results.

Synchronize a conversation from its beginning. GET https://{subdomain}.unipile.com:{port}/api/v1/chats/{chat_id}/sync. This route can be used both to initiate a synchronization process and to monitor its status via regular polling.

List all emails. GET https://{subdomain}.unipile.com:{port}/api/v1/emails. Returns a list of emails.

Retrieve an email. GET https://{subdomain}.unipile.com:{port}/api/v1/emails/{email_id}. Retrieve the details of an email.

Retrieve an attachment from an email. GET https://{subdomain}.unipile.com:{port}/api/v1/emails/{email_id}/attachments/{attachment_id}. Retrieve one of the attachment linked to an email. Unipile answers this route with the file's raw bytes. This connection has no artifact transport, so the tool returns the file's content type and byte length instead of its contents.

List email contacts. GET https://{subdomain}.unipile.com:{port}/api/v1/emails/contacts. Returns a list of contacts from the email provider. Supported for Gmail (Google OAuth) and Microsoft (Outlook) only.

List all folders. GET https://{subdomain}.unipile.com:{port}/api/v1/folders. Returns a list of all email folders.

Retrieve a folder. GET https://{subdomain}.unipile.com:{port}/api/v1/folders/{folder_id}. Retrieve the details of a mail folder.

Retrieve a company profile. GET https://{subdomain}.unipile.com:{port}/api/v1/linkedin/company/{identifier}. Get a company profile from its name or ID.

Retrieve contracts. GET https://{subdomain}.unipile.com:{port}/api/v1/linkedin/contracts. Returns a list of your LinkedIn available contracts

Get inmail credit balance. GET https://{subdomain}.unipile.com:{port}/api/v1/linkedin/inmail_balance. Get balance for subscribed premium features.

List all job postings. GET https://{subdomain}.unipile.com:{port}/api/v1/linkedin/jobs. Retrieve the job offers you have posted on LinkedIn whether they are open, closed or still drafts.

Get a specific applicant to a job posting. GET https://{subdomain}.unipile.com:{port}/api/v1/linkedin/jobs/applicants/{applicant_id}. 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. GET https://{subdomain}.unipile.com:{port}/api/v1/linkedin/jobs/applicants/{applicant_id}/resume. This route can be used to download the resume of a job applicant. Unipile answers this route with the file's raw bytes. This connection has no artifact transport, so the tool returns the file's content type and byte length instead of its contents.

List all applicants to a job posting. GET https://{subdomain}.unipile.com:{port}/api/v1/linkedin/jobs/{id}/applicants. Retrieve all the users that have applied to a given offer.

Get job offer. GET https://{subdomain}.unipile.com:{port}/api/v1/linkedin/jobs/{job_id}. Retrieve a job offer.

Retrieve Recruiter hiring projects. GET https://{subdomain}.unipile.com:{port}/api/v1/linkedin/projects. Retrieve list of LinkedIn Recruiter hiring projects.

Retrieve Recruiter hiring project from ID. GET https://{subdomain}.unipile.com:{port}/api/v1/linkedin/projects/{id}. Retrieve a particular hiring project.

Retrieve LinkedIn search parameters. GET https://{subdomain}.unipile.com:{port}/api/v1/linkedin/search/parameters. 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

List all messages. GET https://{subdomain}.unipile.com:{port}/api/v1/messages. Returns a list of messages. Some optional parameters are available to filter the results.

Retrieve a message. GET https://{subdomain}.unipile.com:{port}/api/v1/messages/{message_id}. Retrieve the details of a message.

Retrieve an attachment from a message. GET https://{subdomain}.unipile.com:{port}/api/v1/messages/{message_id}/attachments/{attachment_id}. Retrieve one of the attachment linked to a message. Unipile answers this route with the file's raw bytes. This connection has no artifact transport, so the tool returns the file's content type and byte length instead of its contents.

Retrieve a post. GET https://{subdomain}.unipile.com:{port}/api/v1/posts/{post_id}. Retrieve the details of a post.

List all comments from a post. GET https://{subdomain}.unipile.com:{port}/api/v1/posts/{post_id}/comments. Returns a list of either comments on a given post or replies on a given comment.

List all reactions from a post. GET https://{subdomain}.unipile.com:{port}/api/v1/posts/{post_id}/reactions. Returns a list of reactions to either a post or a post comment.

Retrieve a profile. GET https://{subdomain}.unipile.com:{port}/api/v1/users/{identifier}. Retrieve the profile of a user. Ensure careful implementation of this action and consult provider limits and restrictions: https://developer.unipile.com/docs/provider-limits-and-restrictions

List all comments. GET https://{subdomain}.unipile.com:{port}/api/v1/users/{identifier}/comments. Returns a list of comments written by a user.

List all posts. GET https://{subdomain}.unipile.com:{port}/api/v1/users/{identifier}/posts. Returns a list of posts written by a user or a company.

List all reactions. GET https://{subdomain}.unipile.com:{port}/api/v1/users/{identifier}/reactions. Returns a list of reactions to posts or comments from a user.

List all followers. GET https://{subdomain}.unipile.com:{port}/api/v1/users/followers. Returns a list of all the followers of the current user. Ensure careful implementation of this action and consult provider limits and restrictions: https://developer.unipile.com/docs/provider-limits-and-restrictions

List all followed accounts. GET https://{subdomain}.unipile.com:{port}/api/v1/users/following. Returns a list of all the followed accounts of an account. Ensure careful implementation of this action and consult provider limits and restrictions: https://developer.unipile.com/docs/provider-limits-and-restrictions

List all invitations received. GET https://{subdomain}.unipile.com:{port}/api/v1/users/invite/received. Returns a list of all invitations that have been received.

List all invitations sent. GET https://{subdomain}.unipile.com:{port}/api/v1/users/invite/sent. Returns a list of all invitations sent that are pending.

Retrieve own profile. GET https://{subdomain}.unipile.com:{port}/api/v1/users/me. Retrieve informations about account owner.

List all relations. GET https://{subdomain}.unipile.com:{port}/api/v1/users/relations. Returns a list of all the relations of an account. Ensure careful implementation of this action and consult provider limits and restrictions: https://developer.unipile.com/docs/provider-limits-and-restrictions

List all webhooks. GET https://{subdomain}.unipile.com:{port}/api/v1/webhooks. Returns a list of the webhooks.

Update account proxy. PATCH https://{subdomain}.unipile.com:{port}/api/v1/accounts/{id}. Update the proxy configuration of an existing account. You can provide a custom proxy, or request a new Unipile proxy by country/IP.

Edit an event. PATCH https://{subdomain}.unipile.com:{port}/api/v1/calendars/{calendar_id}/events/{event_id}. Edit a calendar event.

Perform an action on a given chat. PATCH https://{subdomain}.unipile.com:{port}/api/v1/chats/{chat_id}. Perform an action like changing the read status, muting the chat, retrieving a group invite link, etc.

Edit a job posting. PATCH https://{subdomain}.unipile.com:{port}/api/v1/linkedin/jobs/{job_id}. Edit an existing job posting.

Edit a message. PATCH https://{subdomain}.unipile.com:{port}/api/v1/messages/{message_id}. Edit a message. Supported for WhatsApp and LinkedIn Classic only. WhatsApp may reject edits after an indicative 15-minute window following the original send time. LinkedIn Classic edits are only possible within the first 60 minutes after the message is sent.

Edit own profile. PATCH https://{subdomain}.unipile.com:{port}/api/v1/users/me/edit. Modify informations on account owner profile. For WhatsApp accounts, only headline (profile display name), summary (profile About/status) and picture are available. For Instagram accounts, only summary (profile bio) and picture are available. They should be formatted with brackets like the following examples: location[id]=105015875, picture_settings[filter]=STUDIO or picture_settings[layout][bottomLeft][x]=1.25. When working with arrays, just set one field for each value with the same key, for example: experience[skills]=development \ experience[skills]=management. Attachments are not supported on this connection: Unipile accepts this operation only as multipart/form-data, and its file properties (cover_picture, education.attachment.file, education.attachment.thumbnail, experience.attachment.file, experience.attachment.thumbnail, picture) are omitted from this tool's schema because unbounded bytes must not enter a tool argument. Every text field is available and is sent as a multipart text part. An experience or education attachment must be a LINK (type, title, url): the media variant is not available on this connection, because its file is an upload and uploads cannot be tool arguments.

Restart an account. POST https://{subdomain}.unipile.com:{port}/api/v1/accounts/{id}/restart. Restart the sources of a frozen account.

Solve a code checkpoint. POST https://{subdomain}.unipile.com:{port}/api/v1/accounts/checkpoint. 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.

Resend checkpoint notification. POST https://{subdomain}.unipile.com:{port}/api/v1/accounts/checkpoint/resend. Might it be 2FA, OTP or In-app Validation, this route makes you able on certain providers to resend the notification.

Create an event. POST https://{subdomain}.unipile.com:{port}/api/v1/calendars/{calendar_id}/events. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. Create a calendar event.

Start a new chat. POST https://{subdomain}.unipile.com:{port}/api/v1/chats. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. Start a new conversation with one or more attendee. Attachments are not supported on this connection: Unipile accepts this operation only as multipart/form-data, and its file properties (attachments, linkedin.follow_up.attachments, video_message, voice_message) are omitted from this tool's schema because unbounded bytes must not enter a tool argument. Every text field is available and is sent as a multipart text part.

Send a message in a chat. POST https://{subdomain}.unipile.com:{port}/api/v1/chats/{chat_id}/messages. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. Send a message to the given chat with the possibility to link some attachments. Attachments are not supported on this connection: Unipile accepts this operation only as multipart/form-data, and its file properties (attachments, video_message, voice_message) are omitted from this tool's schema because unbounded bytes must not enter a tool argument. Every text field is available and is sent as a multipart text part.

Create a draft. POST https://{subdomain}.unipile.com:{port}/api/v1/drafts. Interactive documentation does not work on this route (child parameters not correctly applied in snippet), Create a new draft. Attachments are not supported on this connection: Unipile accepts this operation only as multipart/form-data, and its file properties (attachments) are omitted from this tool's schema because unbounded bytes must not enter a tool argument. Every text field is available and is sent as a multipart text part.

Send an email. POST https://{subdomain}.unipile.com:{port}/api/v1/emails. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. 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 Attachments are not supported on this connection: Unipile accepts this operation only as multipart/form-data, and its file properties (attachments) are omitted from this tool's schema because unbounded bytes must not enter a tool argument. Every text field is available and is sent as a multipart text part.

Connect an account (hosted authentication). POST https://{subdomain}.unipile.com:{port}/api/v1/hosted/accounts/link. Create a url which redirect to Unipile's hosted authentication to connect or reconnect an account.

Get raw data from any endpoint. POST https://{subdomain}.unipile.com:{port}/api/v1/linkedin. 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.

Select contract. POST https://{subdomain}.unipile.com:{port}/api/v1/linkedin/contracts/{id}/select. Select a Recruiter or Sales navigator contract to be used on your account

Create a job posting. POST https://{subdomain}.unipile.com:{port}/api/v1/linkedin/jobs. Create a new job offer draft.

Solve a job publishing checkpoint. POST https://{subdomain}.unipile.com:{port}/api/v1/linkedin/jobs/{draft_id}/checkpoint. Solve a checkpoint to verify your member privilegies.

Publish a job posting. POST https://{subdomain}.unipile.com:{port}/api/v1/linkedin/jobs/{draft_id}/publish. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. Publish the job posting draft you have been working on.

Close a job posting. POST https://{subdomain}.unipile.com:{port}/api/v1/linkedin/jobs/{id}/close. Close a job offer you have posted.

Endorse a user profile specific skill. POST https://{subdomain}.unipile.com:{port}/api/v1/linkedin/profile/endorse. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. This route can be used to endorse a skill of a user profile.

Perform Linkedin search. POST https://{subdomain}.unipile.com:{port}/api/v1/linkedin/search. 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

Perform an action with a user profile. POST https://{subdomain}.unipile.com:{port}/api/v1/linkedin/user/{user_id}. Add a candidate to a Recruiter pipeline, save a Sales Navigator lead, etc.

Forward a message. POST https://{subdomain}.unipile.com:{port}/api/v1/messages/{message_id}/forward. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. Forward a message to a chat. (Whatsapp only)

Add a reaction to a message. POST https://{subdomain}.unipile.com:{port}/api/v1/messages/{message_id}/reaction. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. Add a reaction to a message. (Whatsapp, LinkedIn, Telegram, Instagram)

Create a post. POST https://{subdomain}.unipile.com:{port}/api/v1/posts. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. Publish a post. Attachments are not supported on this connection: Unipile accepts this operation only as multipart/form-data, and its file properties (attachments, video_thumbnail) are omitted from this tool's schema because unbounded bytes must not enter a tool argument. Every text field is available and is sent as a multipart text part.

Comment a post. POST https://{subdomain}.unipile.com:{port}/api/v1/posts/{post_id}/comments. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. Comment a post or reply to a post comment. Attachments are not supported on this connection: Unipile accepts this operation only as multipart/form-data, and its file properties (attachments) are omitted from this tool's schema because unbounded bytes must not enter a tool argument. Every text field is available and is sent as a multipart text part.

Add a reaction to a post. POST https://{subdomain}.unipile.com:{port}/api/v1/posts/reaction. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. React to either a post or a post comment.

Send an invitation. POST https://{subdomain}.unipile.com:{port}/api/v1/users/invite. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. Send an invitation to add someone to your contacts. Ensure careful implementation of this action and consult provider limits and restrictions: https://developer.unipile.com/docs/provider-limits-and-restrictions

Handle a received invitation. POST https://{subdomain}.unipile.com:{port}/api/v1/users/invite/received/{invitation_id}. IRREVERSIBLE OUTWARD ACTION: this is visible to someone other than the account owner and cannot be undone through this API. Accept or decline a connection invitation.

Create a webhook. POST https://{subdomain}.unipile.com:{port}/api/v1/webhooks. Create a webhook.

Update an email. PUT https://{subdomain}.unipile.com:{port}/api/v1/emails/{email_id}. Update an email.