All endpoints
Every route of the Emelia API on one page, grouped by topic, with a link to its reference page and playground, and the OpenAPI specs to download.
Every route below has its own page, under its topic in the menu: parameters, request body, responses with realistic examples, code in cURL, JavaScript and Python, and a playground to send real requests with your key.
Emelia API
https://api.emelia.io114 routes, 4 webhook events. Header: Authorization: YOUR_API_KEY
The specs are OpenAPI 3.1 files: import them in Postman or Insomnia, generate a client, or give them to an AI agent.
Emelia API
- GET
/advanced/campaignsList campaigns - POST
/advanced/campaignsCreate a campaign - GET
/advanced/campaigns/{campaignId}Get a campaign - PATCH
/advanced/campaigns/{campaignId}/stepsReplace the sequence - PATCH
/advanced/campaigns/{campaignId}/settingsUpdate campaign settings - PATCH
/advanced/campaigns/{campaignId}/identitiesSet the sender identities - PATCH
/advanced/campaigns/{campaignId}/recipientsSet the contact lists of a campaign - POST
/advanced/campaigns/{campaignId}/test-emailSend a test email - POST
/advanced/campaigns/{campaignId}/startStart a campaign - PATCH
/advanced/campaigns/{campaignId}/planned-startSchedule or cancel a planned start - POST
/advanced/campaigns/{campaignId}/pausePause a campaign - POST
/advanced/campaigns/{campaignId}/finishMark a campaign as finished - POST
/advanced/campaigns/{campaignId}/reactivateReactivate a finished campaign - PATCH
/advanced/campaigns/{campaignId}/nameRename a campaign - POST
/advanced/campaigns/{campaignId}/duplicateDuplicate a campaign - POST
/advanced/campaigns/{campaignId}/archiveArchive a campaign - DEL
/advanced/campaigns/{campaignId}Delete a campaign - GET
/advanced/campaign/contactsList the contacts of a campaign - POST
/advanced/campaign/contactsAdd a contact to a campaign - DEL
/advanced/campaign/contactsRemove a contact from a campaign - PATCH
/advanced/contactsSet a field on a campaign contact - GET
/advanced/campaigns/{campaignId}/manual-tasksList pending manual tasks - POST
/advanced/campaigns/{campaignId}/manual-tasks/statusComplete a manual task - GET
/advanced/campaigns/{campaignId}/progressGet per step progress - GET
/advanced/campaigns/{campaignId}/progress/contactsList the contacts of a step - GET
/advanced/campaigns/{campaignId}/exportExport campaign data as CSV - GET
/stats/advancedGet campaign statistics - POST
/advanced/attachmentsUpload message attachments - POST
/advanced/linkedin/audioUpload a LinkedIn voice note
- GET
/emails/campaign/contactsList email campaign contacts (paginated)deprecated - POST
/emails/campaign/contactsAdd a contact to an email campaigndeprecated - DEL
/emails/campaign/contactsRemove a contact from an email campaigndeprecated - POST
/emails/lists/contactsAdd a contact to an email listdeprecated - GET
/emails/campaignsList email campaignsdeprecated - POST
/emails/campaignsCreate an email campaigndeprecated - GET
/emails/campaigns/{campaignId}Get email campaign detailsdeprecated - PATCH
/emails/campaigns/{campaignId}/settings/globalUpdate email campaign schedule (global settings)deprecated - PATCH
/emails/campaigns/{campaignId}/settings/providersUpdate email campaign sending providersdeprecated - PATCH
/emails/campaigns/{campaignId}/nameRename an email campaigndeprecated - PATCH
/emails/campaigns/{campaignId}/stepsReplace email campaign stepsdeprecated - POST
/emails/campaigns/{campaignId}/startStart an email campaigndeprecated - POST
/emails/campaigns/{campaignId}/pausePause an email campaigndeprecated - PATCH
/emails/contactsSet a custom field on an email contactdeprecated - GET
/emails/campaigns/{campaignId}/activitiesGet email campaign activitiesdeprecated - POST
/emails/testSend a test emaildeprecated - GET
/statsGet email campaign statisticsdeprecated
- GET
/linkedin/campaign/contactsList LinkedIn campaign contacts (paginated)deprecated - POST
/linkedin/campaign/contactsAdd a contact to a LinkedIn campaigndeprecated - DEL
/linkedin/campaign/contactsRemove a contact from a LinkedIn campaigndeprecated - GET
/linkedin/campaignsList LinkedIn campaignsdeprecated - POST
/linkedin/campaignsCreate a LinkedIn campaigndeprecated - PATCH
/linkedin/campaigns/{campaignId}/settings/globalUpdate LinkedIn campaign schedule (global settings)deprecated - PATCH
/linkedin/campaigns/{campaignId}/nameRename a LinkedIn campaigndeprecated - PATCH
/linkedin/campaigns/{campaignId}/stepsReplace LinkedIn campaign stepsdeprecated - GET
/linkedin/campaigns/{campaignId}/activitiesGet LinkedIn campaign activitiesdeprecated - GET
/stats/linkedinGet LinkedIn campaign statisticsdeprecated
- GET
/lists/listList your lists - POST
/lists/listCreate a list - GET
/lists/list/{listId}Get a list - PATCH
/lists/list/{listId}Rename a list - DEL
/lists/list/{listId}Delete a list - POST
/lists/list/exportExport lists as CSV - GET
/lists/list/campaign-usageFind the campaigns using lists - GET
/lists/list/{listId}/rowsList or find the contacts of a list - DEL
/lists/list/{listId}/rows/{leadId}Delete a contact - POST
/lists/list/{listId}/contactsAdd a contact to a list (add or update) - POST
/lists/list/{listId}/contacts/batchAdd up to 100 contacts to a list - PATCH
/lists/contacts/{contactId}Update a contact - POST
/lists/custom-variableCreate a custom variable - GET
/lists/custom-variable/checkCheck whether a custom variable exists - GET
/lists/list/export/jobs/{jobId}Get the status of an export - GET
/lists/list/export/jobs/{jobId}/downloadDownload a finished export
- POST
/emails/blacklists/contactAdd an email or domain to the account blacklist - DEL
/emails/blacklists/contactRemove an email or domain from the account blacklist - GET
/emails/blacklistsGet the account blacklists - POST
/emails/blacklists/linkedinAdd a LinkedIn profile to the blacklist - DEL
/emails/blacklists/linkedinRemove a LinkedIn profile from the blacklist
- GET
/email-providersList email providers - POST
/email-providersConnect an SMTP/IMAP mailbox - PATCH
/email-providers/{providerId}Update an SMTP/IMAP mailbox - PATCH
/email-providers/{providerId}/sender-nameChange the sender name - DEL
/email-providers/{providerId}Delete a mailbox - GET
/email-providers/warmupList warmups - POST
/email-providers/warmup/enableEnable the warmup of a mailbox - POST
/email-providers/warmup/check-healthRun a deliverability diagnosis
- POST
/linkedin-scrappersCreate a LinkedIn scraper (start an extraction) - GET
/linkedin-scrappersList your LinkedIn scrapers - GET
/linkedin-scrappers/{id}Get one LinkedIn scraper (poll its progress) - GET
/linkedin-scrappers/{id}/downloadDownload the contacts of a scraper (CSV) - POST
/linkedin-scrappers/{id}/enrichFind the emails of a finished scraper - POST
/linkedin-scrappers/{id}/filterRemove contacts already extracted by your other scrapers - PUT
/linkedin-scrappers/{id}/pausePause a segmented extraction - PUT
/linkedin-scrappers/{id}/resumeResume a paused, scheduled or failed scraper - POST
/linkedin-scrappers/{id}/splitDetach the part already extracted from a segmented extraction - PUT
/linkedin-scrappers/{id}/renameRename a LinkedIn scraper - DEL
/linkedin-scrappers/{id}Delete a LinkedIn scraper - POST
/linkedin-scrappers/{id}/webhookRegister a webhook on a scraper - DEL
/linkedin-scrappers/{id}/webhookRemove a webhook from a scraper - POST
/linkedin-scrappers/authesConnect a LinkedIn account for scraping (session cookies) - PUT
/linkedin-scrappers/authes/{id}Refresh the cookies of a connected scraping account