Skip to content
Changelog

Report a bug

Emelia integration: operations for AI agents

Emelia connects to Type.com as an integration. This page lists the 86 operations documented for Claude and Codex in Type.com: 35 read, 36 write, 15 destructive.

About Emelia

Emelia is an all-in-one B2B prospecting tool offering features like cold-emailing, LinkedIn outreach, email warm-up, email finder, and LinkedIn Sales Navigator scraping.

Categories: Email & Messaging

How to connect Emelia to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

86 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

86 operations listed.

Campaigns

  • Read

    List campaigns

    Returns all multichannel campaigns of the account except archived ones, newest first. No pagination. Use all=true to get an extra first item ALLCAMPAIGNS (used to register a webhook on every campaign).

  • Read

    Get a campaign

    Returns the full campaign: schedule (settings), sequence tree (steps), identities, attached lists with their contact count, status and dates. Read it before any PATCH: the steps and settings routes replace what you send.

  • Write

    Create a campaign

    Creates an empty multichannel campaign in DRAFT status with default settings (35 new email contacts per day, 100 emails per day, 20 LinkedIn contacts per day, Monday to Friday 08:00 to 17:00, tracking off) and a sequence that only contains the START step.

  • Write

    Rename a campaign

    Renames the campaign. Not allowed while the campaign is RUNNING.

  • Write

    Replace the sequence

    Replaces the WHOLE sequence tree of the campaign. Always GET the campaign first, modify the steps object and send the complete tree back. The campaign must not be RUNNING (pause it first).

  • Write

    Update campaign settings

    Merges the given settings into the campaign schedule. Not allowed while RUNNING. Rules: start must be before end; dailyEmailLimit must be greater than or equal to dailyEmailAdded; dailyLinkedinAdded is capped at 40 when the sequence contains a CONNECTION step (80 otherwise).

  • Write

    Set the contact lists of a campaign

    Sets the FULL selection of lists (replace semantics): the campaign contacts become the contacts of lists, minus any contact whose email or LinkedIn URL appears in one of excludedLists. When excludedLists is omitted the current exclusion lists are kept.

  • Write

    Set the sender identities

    Replaces the identities (sending accounts) of the campaign. Not allowed while RUNNING. For each step Emelia picks automatically, among these identities, the least used one that has an account on the channel.

  • Write

    Start a campaign

    Starts (or resumes) the campaign. Requires an active subscription.

  • Write

    Pause a campaign

    Pauses a RUNNING campaign: its scheduled actions, pending conditions and pending manual tasks are deleted. They are created again when the campaign is restarted and the contacts reach those steps again.

  • Write

    Schedule or cancel a planned start

    Schedules an automatic start at plannedStart (ISO 8601 date in the future). The campaign must pass the start checks at scheduling time (same errors as POST .../start). Send null (or an empty value) to cancel a planned start.

  • Write

    Duplicate a campaign

    Creates a new DRAFT campaign from an existing one. Choose what to copy. Copied contacts and lists are shared references (not copies). The new name must be unique.

  • Write

    Reactivate a finished campaign

    Moves a FINISHED campaign back to PAUSED so that it can be edited and started again.

  • Write

    Mark a campaign as finished

    Moves a RUNNING or PAUSED campaign to FINISHED and deletes its scheduled actions and pending conditions.

  • Write

    Send a test email

    Sends one version of an EMAIL step to email, from one of the campaign identities, with the variables of a random contact of the campaign. Use the step id and version id from GET /advanced/campaigns/{campaignId}.

  • Destructive

    Delete a campaign

    Deletes the campaign. A running campaign must be paused first. Irreversible.

  • Destructive

    Archive a campaign

    Sets the status to ARCHIVED (hidden from GET /advanced/campaigns). A running campaign must be paused first.

Campaign contacts

  • Read

    List the contacts of a campaign

    Paginated contacts of a campaign with their status in the campaign. page is ZERO based. perPage below 10 is replaced by 20; maximum 10,000.

  • Write

    Add a contact to a campaign

    Adds ONE contact to a multichannel campaign. The contact is stored in a list named " contacts from API" (created if needed) attached to the campaign.

  • Write

    Set a field on a campaign contact

    Sets one field of a contact that belongs to the campaign, found by email OR linkedinUrlProfile (exactly one of them). Spaces are removed from fieldName.

  • Destructive

    Remove a contact from a campaign

    Removes one contact from the campaign recipients and deletes its activities in this campaign (in the background). The contact itself and its lists are kept. The parameters are sent in the JSON BODY of the DELETE request.

Campaign tracking

  • Read

    List campaign activities

    Activities of the campaign, newest first, 30 per page. page is ZERO based; an empty array means you reached the end. Results are cached for up to 10 minutes. Filters: contactId wins over search, which wins over query. When query is an exact email, the type filters are ignored.

  • Read

    Get the message of a send activity

    Rebuilds the content sent for a SENT, MESSAGESENT, INMAILSENT, INVITED or WHATSAPPMESSAGESENT activity by replaying the step template against the contact. The sent content itself is not stored: the result can differ if the step or the contact changed since.

  • Read

    List pending manual tasks

    Pending TASK steps of the campaign (contacts waiting for you to do something by hand), oldest first. Pausing the campaign deletes pending tasks; they are created again after the next start, when contacts reach the task step again.

  • Read

    Get per step progress

    For each step id: how many contacts already passed the step (completed) and how many are currently waiting at it (waiting). Works on paused campaigns. Returns {} for a DRAFT or unknown campaign.

  • Read

    List the contacts of a step

    Contacts that passed (completed) or wait at (waiting) a given step, newest first, 20 per page. Here page is ONE based.

  • Read

    Export campaign data as CSV

    Returns a CSV file (UTF-8 with BOM, Content-Disposition: attachment). contacts: one line per contact with its custom fields, activities and replied flag; activities: activity log; replies: replies. Optional date range on activities.

  • Read

    Get campaign statistics

    Global and per step statistics of a multichannel campaign. Computed on demand (can take several seconds) and then cached; Cache-Control: max-age=300 is set when detailed is not true.

  • Write

    Complete a manual task

    Marks the task of one contact as done (ok, event TASKCOMPLETED) or failed (ko, event TASKFAILED) and moves the contact to the next step. A task can only be completed once.

Uploads

  • Write

    Upload message attachments

    Uploads 1 to 3 files (20 MB maximum each) and returns their URLs, to reference in versions[].attachments of EMAIL, MESSAGE or WHATSAPP steps. Files are stored as is with a PUBLIC URL: anyone with the URL can download them.

  • Write

    Upload a LinkedIn voice note

    Converts an audio file (webm expected, 10 MB maximum, 5 minutes maximum) to m4a and returns a PUBLIC URL plus its duration IN MILLISECONDS, to use as an attachment with mediaType: "AUDIO" in a MESSAGE step.

Enrichment tools

  • Read

    List email searches

    History of your single email searches, newest first. page is one based.

  • Read

    Find the email of a person

    Starts an email search for one person and returns a jobId immediately. Cost: 1 credit, debited when the job starts and refunded when no email is found (it is NOT refunded when the search times out).

  • Read

    Get an email search result

    Returns the job. While status is running, poll again. When done, email holds the result (absent if nothing was found).

  • Read

    List phone searches

    History of your single phone searches, newest first. page is one based.

  • Read

    Find the phone number of a person

    Starts a mobile phone search from a LinkedIn profile URL and returns a jobId. Cost: 50 credits, debited when the job starts and refunded when no number is found (results found during the last 6 months are served from cache and still cost 50 credits).

  • Read

    Get a phone search result

    Returns the job. qualification is found and phoneNumber is set when a number was found.

  • Read

    List email verifications

    History of your single verifications, newest first. page is one based.

  • Read

    Get an email verification result

    Returns the job with its qualification once status is done.

  • Write

    Verify an email address

    Starts the verification of one email address and returns a jobId. Cost: 0.25 credit, never refunded (even when the provider fails). Poll GET /tools/verify/email/{jobId} every few seconds; the job is marked error after about 60 seconds without a verdict.

Email providers

  • Read

    List email providers

    All sending mailboxes of the account with the campaigns that use them. Passwords are masked. No pagination. Their id is what you put in identities[].email of a campaign.

  • Read

    List warmups

    Warmup state of every mailbox (a warmup record is created on the fly for mailboxes that have none). No pagination: a page parameter is ignored. The id of an item is the warmup id.

  • Write

    Connect an SMTP/IMAP mailbox

    Adds a mailbox after testing its SMTP and IMAP credentials. The number of mailboxes is limited by your subscription (1 plus the additional mailboxes you pay for).

  • Write

    Update an SMTP/IMAP mailbox

    Updates the credentials of an SMTP or Google IMAP mailbox, retests them and marks the mailbox as connected again. Masked passwords () are replaced by the stored values before the test.

  • Write

    Change the sender name

    Updates only the sender name of a mailbox (any type), without retesting credentials. Note: Outlook always displays the name of the Microsoft account.

  • Write

    Enable the warmup of a mailbox

    Starts the warmup of a mailbox. Requires an active subscription. providerId accepts the email provider id or the warmup id. The mailbox connection is tested first. Some hosts are refused (WARMUPPROVIDERUNSUPPORTED).

  • Write

    Run a deliverability diagnosis

    Asks for a new DNS, sending and blacklist diagnosis of a mailbox. Asynchronous: the result appears a few minutes later in health of GET /email-providers/warmup. Note: a missing warmupId returns {"success": false, "message": ...}, not the usual error format.

  • Destructive

    Delete a mailbox

    Removes the mailbox from the account.

Account

  • Read

    List credit debits

    History of the credits really consumed (refunds and refunded debits are not listed), newest first. page is one based.

Lists

  • Read

    List your lists

    Returns the contact lists of the account (top-level lists only: lists attached to a parent list are not returned). Pagination is opt-in. Send page and/or limit to get the paginated envelope { items, total, page, pageSize, totalLeads }.

  • Read

    Get a list

    Returns one list with its counters. The counters are denormalized: numberOfEmails and numberOfPhones count the contacts that had an email or a phone (not mobilePhone) when they were added, and are recomputed only at the end of a find-email or find-phone run.

  • Read

    Export lists as CSV

    Exports one list as a CSV file, or several lists as a ZIP archive with one CSV per list. CSV format: UTF-8 with BOM, comma separator, CRLF line endings.

  • Read

    Find the campaigns using lists

    For each list id, returns the non-archived campaigns that include the list in their recipients. Use it to know whether adding contacts to a list will feed a campaign. Lists used only as exclusion lists are not reported.

  • Write

    Create a list

    Creates an empty list with source API and status mapped, immediately ready to receive contacts through POST /lists/list/{listId}/contacts or the batch route. List names do not need to be unique: calling this twice creates two lists, so store the returned listId.

  • Write

    Rename a list

    Renames a list. Only name can be changed through this route.

  • Destructive

    Delete a list

    Permanently deletes the list, every contact and company row it contains, and its child or linked lists.

List contacts

  • Read

    List or find the contacts of a list

    Two modes. Exact lookup (use it before an update or a delete): pass email OR linkedinUrl. The email is matched exactly but case-insensitively, the LinkedIn URL is compared as an exact string (a trailing slash or a missing www is a different URL).

  • Write

    Add a contact to a list (add or update)

    Adds ONE contact to a list from a flat JSON object: field names as keys, scalar values (string, number or boolean).

  • Write

    Add up to 100 contacts to a list

    Adds 1 to 100 contacts in one call. Each item of contacts is the same flat object as in POST /lists/list/{listId}/contacts, with the same key resolution, custom variable creation, duplicate rules and updateIfExists behaviour (read that endpoint first).

  • Write

    Update a contact

    Updates a contact identified by its id only (its list is derived from the contact).

  • Destructive

    Delete a contact

    Permanently deletes a contact and its company row. The contact can live in the list or in a list linked to it. It is removed from the campaigns that reference it, the list counters are decremented and the campaigns using the list are resynchronized. This cannot be undone.

List exports

  • Read

    Get the status of an export

    Returns the progress of an asynchronous export started with POST /lists/list/export and async: true. Poll every few seconds until status is done (then call the download route) or failed (read error).

  • Read

    Download a finished export

    Streams the file of a finished asynchronous export (CSV for one list, ZIP for several), as an attachment. Returns 409 while the job is not done.

List custom variables

  • Read

    Check whether a custom variable exists

    Tells whether a name is already taken for a schema, either by one of your custom variables (reason: customvariable) or by a standard field (leadfield or companyfield). The name is normalized with the same rule as the creation route and the normalized technicalName is returned.

  • Write

    Create a custom variable

    Declares a custom variable on the account, so that contact keys with this name (technical or display name) land in it instead of being guessed. Declare your variables before loading contacts.

Linked In scraper

  • Read

    List your LinkedIn scrapers

    Returns the scrapers of your workspace, newest first, 20 per page. Deleted scrapers are not returned. Use it to show a history or to find a scraper id. To follow one extraction, poll GET /linkedin-scrappers/{id} instead: it is lighter and returns the same object.

  • Read

    Get one LinkedIn scraper (poll its progress)

    Returns one scraper with its progress. This is the call to poll while an extraction or an enrichment runs (every 30 to 60 seconds is enough). Reading the progress - status: see ScrapperStatus.

  • Read

    Find the emails of a finished scraper

    Looks for the professional email of every contact of a finished people extraction. Asynchronous: status becomes enriching, then done again when the emails are written into the CSV. An enrichment is closed after about one hour at most, with what was found by then.

  • Read

    Download the contacts of a scraper (CSV)

    Returns the CSV of a scraper as a string in data (a JSON response, not a file). Separator ;, first line = column names, UTF-8 without BOM, values quoted only when needed. Large extractions give large responses (several MB).

  • Write

    Create a LinkedIn scraper (start an extraction)

    Starts extracting the people (or companies) of a LinkedIn search into a CSV. The extraction runs in the background on Emelia servers: this call only creates the scraper and returns its id (scrapId).

  • Write

    Detach the part already extracted from a segmented extraction

    Lets you use now what a long segmented extraction has already collected, while the rest goes on. Effect: a new scraper named 1 is created with status done and the contacts extracted so far; its id is returned in scrapId.

  • Write

    Register a webhook on a scraper

    Registers a URL that Emelia calls when this scraper finishes or stops on an error. Register it right after creating the scraper. Several URLs can be registered on the same scraper; the same URL cannot be added twice.

  • Write

    Connect a LinkedIn account for scraping (session cookies)

    Connects a LinkedIn account for Sales Navigator scraping by sending the cookies of a browser session where the user is logged in to LinkedIn and Sales Navigator. No password is involved. The Emelia browser extension does this for you; use this route to automate it.

  • Destructive

    Delete a LinkedIn scraper

    Deletes a scraper. It disappears from the API and from the app. A Sales Navigator extraction in progress is stopped and the next chunks of a segmented extraction do not start. Pitfalls: the deletion is logical (Emelia keeps the extracted file).

  • Destructive

    Pause a segmented extraction

    Pauses a large extraction split into chunks (segmented: true, Grow and Scale plans). Only allowed while status is running. Other scrapers cannot be paused. The pause is not immediate: the chunk being extracted goes to its end, only the next chunks are unscheduled.

  • Destructive

    Resume a paused, scheduled or failed scraper

    Restarts a scraper that is: - paused (by you, or automatically when credits ran out); - planified: it starts now instead of at plannedStart; - in error with INVALIDCOOKIE or RATELIMIT, once its LinkedIn account is valid again (refresh it first with PUT /linkedin-scrappers/authes…

  • Destructive

    Rename a LinkedIn scraper

    Changes the name of a scraper. 1 to 100 characters, unique among your scrapers. Pitfall: renaming a scraper to its current name is refused (A scrap with this name already exists).

  • Destructive

    Remove a webhook from a scraper

    Unregisters a webhook URL (exact match). The URL goes in the JSON body of the DELETE request: make sure your HTTP client sends a body with DELETE. Removing a URL that is not registered is not an error. Known issue: the success response is currently an empty JSON object {}.

  • Destructive

    Remove contacts already extracted by your other scrapers

    Removes from this scraper the LinkedIn profiles that already appear in your 10 most recent finished scrapers (comparison on the profile id column). Run it on a finished scraper before enriching it: fewer contacts, fewer credits. filters is a bit field.

  • Destructive

    Refresh the cookies of a connected scraping account

    Replaces the session cookies of a scraping account (its authId), typically after a scraper stopped with INVALIDCOOKIE or when the account shows status: invalid. status is set back to valid (the cookies are not tested at this moment).

Blacklist

  • Read

    Get the account blacklists

    Returns the workspace blacklist documents. WARNING: the response is a RAW ARRAY (not wrapped in { success }). Each item carries blacklistContent (email/domain blacklist, newline-separated) and linkedinBlacklistContent (LinkedIn handles, newline-separated).

  • Write

    Add an email or domain to the account blacklist

    Adds an address, or a bare domain (domain.ltd), to the workspace blacklist. The blacklist is account-wide and applies to every current and future campaign.

  • Write

    Add a LinkedIn profile to the blacklist

    Adds a LinkedIn profile to the workspace blacklist. value is a full profile URL (https://www.linkedin.com/in/...) or a bare handle; it is normalised to the handle. Despite living under /emails, this manages the LinkedIn blacklist.

  • Destructive

    Remove an email or domain from the account blacklist

    Removes an address (or bare domain) from the workspace blacklist.

  • Destructive

    Remove a LinkedIn profile from the blacklist

    Removes a LinkedIn profile (URL or handle) from the workspace blacklist.

Webhooks

  • Read

    List webhooks

    Returns the activity webhooks registered on the campaigns of the authenticated account: legacy email campaigns (typeOfCampaign: email), legacy LinkedIn campaigns (linkedin) and advanced campaigns (advanced), whatever their status (FINISHED and ARCHIVED included).

See How connections work for access and permissions, or browse all integrations.