# Lancepilot API Documentation

## Docs

- [Introduction](https://api.lancepilot.com/index.md): Meet the World’s First WhatsApp Cold Outreach Tool! Integrate WhatsApp messaging into your CRM, marketing tools, or custom applications for streamlined communication and improved conversions.
- [Get Channel](https://api.lancepilot.com/pages/endpoints/channel/get.md): Retrieve the channel for the specified workspace.
- [Get Conversations](https://api.lancepilot.com/pages/endpoints/channel/wallet/conversation.md): Retrieve the conversation list for the specified workspace's wallet.
- [Download Invoice](https://api.lancepilot.com/pages/endpoints/channel/wallet/invoice.md): Download the invoice for a specific wallet transaction as a PDF file.
- [Refresh Wallet](https://api.lancepilot.com/pages/endpoints/channel/wallet/refresh.md): Refresh the wallet channel for the specified workspace.
- [Get Transactions](https://api.lancepilot.com/pages/endpoints/channel/wallet/transactions.md): Retrieve wallet transactions for the specified workspace.
- [Get Transfer List](https://api.lancepilot.com/pages/endpoints/channel/wallet/transfer.md): Retrieve wallet transfer details for the specified workspace.
- [Add Contact Field](https://api.lancepilot.com/pages/endpoints/contact-field/add.md): Create a new contact field in the specified workspace.
- [Delete Contact Field](https://api.lancepilot.com/pages/endpoints/contact-field/delete.md): Delete a contact field by ID.
- [Get Contact Field](https://api.lancepilot.com/pages/endpoints/contact-field/get.md): Retrieve a specific contact field by ID.
- [Get Contact Fields](https://api.lancepilot.com/pages/endpoints/contact-field/list.md): Retrieve all contact fields for a workspace.
- [Update Contact Field](https://api.lancepilot.com/pages/endpoints/contact-field/update.md): Update an existing contact field in the specified workspace.
- [Add Contact Group](https://api.lancepilot.com/pages/endpoints/contact-group/add.md): Create a new contact group in the specified workspace.
- [Delete Contact Group](https://api.lancepilot.com/pages/endpoints/contact-group/delete.md): Delete a contact group by ID.
- [Get Contact Group](https://api.lancepilot.com/pages/endpoints/contact-group/get.md): Retrieve a specific contact group by ID.
- [Get Contact Groups](https://api.lancepilot.com/pages/endpoints/contact-group/list.md): Retrieve all contact groups for a workspace.
- [Update Contact Group](https://api.lancepilot.com/pages/endpoints/contact-group/update.md): Update an existing contact group in the specified workspace.
- [Add Contact Import](https://api.lancepilot.com/pages/endpoints/contact-import/add.md): Create a new contact import in the specified workspace.
- [Delete Contact Import](https://api.lancepilot.com/pages/endpoints/contact-import/delete.md): Delete a contact import by ID in the specified workspace.
- [Download Contact Import](https://api.lancepilot.com/pages/endpoints/contact-import/download.md): Download the file of a specific contact import as a CSV file.
- [Get Contact Import](https://api.lancepilot.com/pages/endpoints/contact-import/get.md): Retrieve a specific contact import by ID in the specified workspace.
- [Get Contact Imports](https://api.lancepilot.com/pages/endpoints/contact-import/list.md): Retrieve all contact imports for the specified workspace.
- [Update Contact Import](https://api.lancepilot.com/pages/endpoints/contact-import/update.md): Update an existing contact import in the specified workspace.
- [Add Contacts](https://api.lancepilot.com/pages/endpoints/contacts/add.md): Create a new contact in the workspace.
- [Delete Contact](https://api.lancepilot.com/pages/endpoints/contacts/delete.md): Delete a contact by ID.
- [Export Contacts](https://api.lancepilot.com/pages/endpoints/contacts/export.md): Download all contacts (optionally filtered by a contact group) as CSV or XLSX.
- [Get Contact](https://api.lancepilot.com/pages/endpoints/contacts/get.md): Retrieve a specific contact by ID.
- [Get Contact by Number](https://api.lancepilot.com/pages/endpoints/contacts/get-number.md): Retrieve a specific contact by WhatsApp number in the workspace.
- [Get Contacts](https://api.lancepilot.com/pages/endpoints/contacts/list.md): Retrieve contacts associated with a specific workspace.
- [Toggle Contact Label](https://api.lancepilot.com/pages/endpoints/contacts/toggle-label.md): Attach or detach a label from a contact. If the label is already attached, it will be detached, and vice versa.
- [Toggle Contact Tag](https://api.lancepilot.com/pages/endpoints/contacts/toggle-tag.md): Attach or detach a tag from a contact. If the tag is already attached, it will be detached, and vice versa.
- [Update Contact](https://api.lancepilot.com/pages/endpoints/contacts/update.md): Update an existing contact in the workspace.
- [Create Label](https://api.lancepilot.com/pages/endpoints/labels/add.md): Create a new label in the specified workspace.
- [Delete Label](https://api.lancepilot.com/pages/endpoints/labels/delete.md): Delete a label by ID. This will also detach the label from all associated contacts.
- [Get Label](https://api.lancepilot.com/pages/endpoints/labels/get.md): Retrieve a specific label by ID.
- [Get Labels](https://api.lancepilot.com/pages/endpoints/labels/list.md): Retrieve all labels associated with the specified workspace.
- [Update Label](https://api.lancepilot.com/pages/endpoints/labels/update.md): Update an existing label in the specified workspace.
- [Audio Message](https://api.lancepilot.com/pages/endpoints/messages/with-id/audio.md): Send a audio message to a specific contact within a workspace.
- [Can Send Free Message](https://api.lancepilot.com/pages/endpoints/messages/with-id/can-send-free.md)
- [Document Message](https://api.lancepilot.com/pages/endpoints/messages/with-id/document.md): Send a document message to a specific contact within a workspace.
- [Image Message](https://api.lancepilot.com/pages/endpoints/messages/with-id/image.md): Send a text message to a specific contact within a workspace.
- [Text Message](https://api.lancepilot.com/pages/endpoints/messages/with-id/text.md): Send a text message to a specific contact within a workspace.
- [Video Message](https://api.lancepilot.com/pages/endpoints/messages/with-id/video.md): Send a video message to a specific contact within a workspace.
- [Audio Message](https://api.lancepilot.com/pages/endpoints/messages/with-number/audio.md): Send a audio message to a specific contact within a workspace.
- [Can Send Free Message](https://api.lancepilot.com/pages/endpoints/messages/with-number/can-send-free.md)
- [Document Message](https://api.lancepilot.com/pages/endpoints/messages/with-number/document.md): Send a document message to a specific contact within a workspace.
- [Image Message](https://api.lancepilot.com/pages/endpoints/messages/with-number/image.md): Send a text message to a specific contact within a workspace.
- [Text Message](https://api.lancepilot.com/pages/endpoints/messages/with-number/text.md): Send a text message to a specific contact within a workspace.
- [Video Message](https://api.lancepilot.com/pages/endpoints/messages/with-number/video.md): Send a video message to a specific contact within a workspace.
- [Subscribe (Id)](https://api.lancepilot.com/pages/endpoints/newsletters/subscribe.md): This endpoint subscribes an existing contact to a newsletter using their **contact_id**.
- [Subscribe (Number)](https://api.lancepilot.com/pages/endpoints/newsletters/subscribe-number.md): This endpoint subscribes a contact to a newsletter using their **WhatsApp number**. If the contact does not exist, a new one will be created with default values.
- [Get Permissions](https://api.lancepilot.com/pages/endpoints/role-and-permissions/get-permissions.md): Retrieve the permissions for the specified workspace.
- [Get Roles](https://api.lancepilot.com/pages/endpoints/role-and-permissions/get-roles.md): Retrieve all roles available in the specified workspace.
- [Add Role](https://api.lancepilot.com/pages/endpoints/roles/add.md): Create a new role in the specified workspace.
- [Delete Role](https://api.lancepilot.com/pages/endpoints/roles/delete.md): Delete a role by ID in the specified workspace.
- [Get role](https://api.lancepilot.com/pages/endpoints/roles/get.md): Retrieve a specific role by ID in the specified workspace.
- [Get Roles](https://api.lancepilot.com/pages/endpoints/roles/list.md): Retrieve all roles for the specified workspace.
- [Update Role](https://api.lancepilot.com/pages/endpoints/roles/update.md): Update an existing role in the specified workspace.
- [Create Tag](https://api.lancepilot.com/pages/endpoints/tags/add.md): Create a new tag in the specified workspace.
- [Delete Tag](https://api.lancepilot.com/pages/endpoints/tags/delete.md): Delete a tag by ID. This will also detach the tag from all associated contacts.
- [Get Tag](https://api.lancepilot.com/pages/endpoints/tags/get.md): Retrieve a specific tag by ID.
- [Get Tags](https://api.lancepilot.com/pages/endpoints/tags/list.md): Retrieve all tags associated with the specified workspace.
- [Update Tag](https://api.lancepilot.com/pages/endpoints/tags/update.md): Update an existing tag in the specified workspace.
- [Send Template Message (Id)](https://api.lancepilot.com/pages/endpoints/template-message/send-id.md): Send a WhatsApp template message to a contact using their contact ID. Templates can include text/media headers, body with variables, footers, and buttons.
- [Send Template Message (Number)](https://api.lancepilot.com/pages/endpoints/template-message/send-number.md): Send a WhatsApp template message to a contact using their phone number. If the contact doesn't exist, it will be automatically created. Templates can include text/media headers, body with variables, footers, and buttons.
- [Add Template](https://api.lancepilot.com/pages/endpoints/templates/add.md)
- [Delete Template](https://api.lancepilot.com/pages/endpoints/templates/delete.md): Delete a template by ID in the specified workspace.
- [Get Template](https://api.lancepilot.com/pages/endpoints/templates/get.md): Retrieve a specific template by ID in the specified workspace.
- [Get Templates](https://api.lancepilot.com/pages/endpoints/templates/list.md): Retrieve all templates for the specified workspace.
- [Sync Templates](https://api.lancepilot.com/pages/endpoints/templates/sync.md): Synchronize templates in the specified workspace.
- [Update Template](https://api.lancepilot.com/pages/endpoints/templates/update.md): Update an existing template. Supports the same payload structure as template creation.
- [Add User](https://api.lancepilot.com/pages/endpoints/users/add.md): Create a new user in the specified workspace.
- [Delete User](https://api.lancepilot.com/pages/endpoints/users/delete.md): Delete a user by ID in the specified workspace.
- [Get User](https://api.lancepilot.com/pages/endpoints/users/get.md): Retrieve a specific user by ID in the specified workspace.
- [Get Users](https://api.lancepilot.com/pages/endpoints/users/list.md): Retrieve all users associated with the specified workspace.
- [Update User](https://api.lancepilot.com/pages/endpoints/users/update.md): Update an existing user in the specified workspace.
- [Create Workspace](https://api.lancepilot.com/pages/endpoints/workspaces/create.md): Create a new workspace for the authenticated user.
- [Delete Workspace](https://api.lancepilot.com/pages/endpoints/workspaces/delete.md): Delete a workspace by ID.
- [Get Workspace](https://api.lancepilot.com/pages/endpoints/workspaces/get.md): Retrieve details of a specific workspace by its ID.
- [Get Workspaces](https://api.lancepilot.com/pages/endpoints/workspaces/list.md): Retrieve a list of all workspaces associated with the authenticated user.
- [Get Partner Permissions](https://api.lancepilot.com/pages/endpoints/workspaces/permissions.md): Retrieve the authenticated user’s default permissions for partner workspaces.
- [Update Workspace](https://api.lancepilot.com/pages/endpoints/workspaces/update.md): Update the specified workspace.
- [Update Partner Permissions](https://api.lancepilot.com/pages/endpoints/workspaces/update-permissions.md): Update the default permissions applied to new partner workspaces created by the user.

## OpenAPI Specs

- [openapi](https://api.lancepilot.com/openapi/openapi.json)

## Optional

- [Website](https://lancepilot.com)
- [Support](https://api.whatsapp.com/send/?phone=447309574692&text=Hi&type=phone_number&app_absent=0k)
- [Channel](https://whatsapp.com/channel/0029Vb5QMExEKyZAhMEB8N2k)
- [Community](https://discord.gg/fVyJhfnQ)
- [Live Demo](https://www.youtube.com/watch?v=AEh8Rq__6B8)