# API Keys Source: https://docs.meetchase.ai/api-reference/api-key Authenticating using an API Key ## Finding your API Key Our Public API authenticates via an API Key. You can generate your API key under 'Manage Organisation/API & Integrations' in your dashboard. [Get API Key](https://app.meetchase.ai/app/organisation-settings) Each time you generate a API Key for your organisation it will overwrite your previous API key across the organisation. Generate API Key # Add Contact to DNC List Source: https://docs.meetchase.ai/api-reference/endpoint/addDNC POST /api/v1/contacts/dnc/add Adds one or more email addresses to an organisation's DNC list. ### Path Parameters - `organisation_id` (`int`): Organisation ID to which DNC contacts are added. ### Request Body ```jsonc { "emails": ["alice@example.com", "bob@example.com"] } ``` ### Headers - `X-API-Key`: API key granting access to the organisation's DNC list. ### Response - Returns a JSON message indicating how many contacts were inserted, e.g. ```jsonc { "message": "2 contact(s) successfully added to the DNC list." } ``` ### Errors - `400 Bad Request`: Payload fails validation (e.g. invalid email address). - `403 Forbidden`: Authenticated user lacks CRUD rights for the organisation. # Add Domain to DNC List Source: https://docs.meetchase.ai/api-reference/endpoint/addDNCDomain POST /api/v1/dnc-domains/json Queues a list of domains to be added to an organisation's DNC list. This operation runs as a background task and returns immediately. ### Path Parameters **organisation_id** (`int`): The ID of the organisation to update. ### Body Parameters **payload** (`DomainList`): A list of domain strings. ### Headers **X-API-Key**: API key granting access to the organisation's DNC list. ### Returns: **JSONResponse**: A confirmation message indicating the task has been queued. # Fetch AI SDRs Source: https://docs.meetchase.ai/api-reference/endpoint/fetchAISDR GET /api/v1/bots Retrieves a list of Bots associated with a specific organisation. ### Path Parameters - `organisation_id` (`int`): The ID of the organisation for which to retrieve the Bots. ### Headers - `X-API-Key`: API key for user authentication. ### Response - Returns a list of `BotExternal` objects, each representing a Bot associated with the organisation. This includes the Bot's ID, email, first name, last name, and any custom data associated with the Bot. ### Errors - `404 Not Found`: If the specified `organisation_id` does not exist. - `403 Forbidden`: If the user does not have the necessary permissions to perform this action or is not a member of the specified organisation. # Fetch Contact Status Source: https://docs.meetchase.ai/api-reference/endpoint/fetchCampaignContactStatus GET /api/v1/campaigns/data/replies This endpoint fetches exchange data, which represents a conversation between a bot and a contact. It can be filtered by campaign, a date range, and the type of exchange (e.g., positive replies vs. meetings booked). ### Query Parameters - **campaign_id** (`int`, optional): The ID of a specific campaign to filter by. If omitted, exchanges from all campaigns are returned. - **start_date** (`str`, optional): The start of the date range for filtering exchanges, in `YYYY-MM-DD` format. **Defaults to `2023-01-01`**. - **end_date** (`str`, optional): The end of the date range for filtering exchanges, in `YYYY-MM-DD` format. **Defaults to the current date**. - **exchange_group** (`str`, optional): The category of exchanges to retrieve. **Defaults to `"replied"`**. Possible values: `"replied"`, `"meeting-booked"`. ### Headers - **X-API-Key**: The API key for authenticating the request. ### Response Returns a JSON array of `BaseExchange` objects. # Fetch Campaigns Source: https://docs.meetchase.ai/api-reference/endpoint/fetchCampaigns GET /api/v1/campaigns Retrieves a list of campaigns associated with a specified organisation. This includes campaigns' names, subjects, statuses, creation dates, and email tracking settings. ### Path Parameters - `organisation_id` (`int`): The ID of the organisation for which campaigns are being fetched. ### Headers - `X-API-Key`: API key for user authentication. Ensures that the request is made by an authorised user. ### Response - Returns a list of `Campaign` objects, each encapsulating details about a specific email campaign, including its ID, name, subject, creation date, status (e.g., pending, active, completed), and whether email tracking is enabled. ### Errors - `403 Forbidden`: If the authenticated user is not a member of the specified organisation. - `404 Not Found`: The campaign does not belong to the specified organisation. # Fetch Contacts Source: https://docs.meetchase.ai/api-reference/endpoint/fetchContacts GET /api/v1/contacts Retrieves a list of all contacts associated with a specified organisation, including their personal and location information. ### Path Parameters - `organisation_id` (`int`): The ID of the organisation whose contacts are being fetched. ### Headers - `X-API-Key`: API key for user authentication. ### Response - Returns a list of `Contact` objects, each representing a contact associated with the organisation. Each object includes the contact's ID, email, first name, last name, custom data, and timezone. ### Errors - `403 Forbidden`: If the user does not have the necessary permissions to access the contacts of the organisation. # Fetch Email Exchange Source: https://docs.meetchase.ai/api-reference/endpoint/fetchEmailExchange GET /api/v1/exchanges/{exchange_id}/emails Retrieves the email chain for a specific exchange. ## Path Parameters - **exchange_id** (`int`): The ID of the exchange whose email chain is to be retrieved. ## Authentication (Headers) - **X-API-Key**: The API key for authenticating the request. ## Returns - **EmailChain**: The email chain associated with the specified exchange. # Fetch Meetings Source: https://docs.meetchase.ai/api-reference/endpoint/fetchMeetings GET /api/v1/meetings Retrieves a list of meetings scheduled within an organisation for a specified date range. ### Query Parameters - `start_date` (`date`, optional): The start date for filtering meetings. Meetings on or after this date will be included. - `end_date` (`date`, optional): The end date for filtering meetings. Meetings on or before this date will be included. ### Headers - `X-API-Key`: The API key for authentication. ### Response - Returns a list of `ExternalMeeting` objects representing each meeting within the specified date range. Each object includes details such as the meeting's start and end times, timezone, summary, status (cancelled or not), meeting link, and participant information. # Log Conversion Source: https://docs.meetchase.ai/api-reference/endpoint/insertConversion POST /api/v2/conversions This endpoint allows a client to log a conversion event for a specific contact within an organisation. It checks if the contact exists in the organisation before logging the conversion in the background. ### Body Parameters - `conversion` (`SubmitConversionV2`): JSON object containing the conversion event details such as contact info and conversion type. ### Authentication - This endpoint requires a valid API key associated with the organisation to be passed via the request headers. ### Response - **202 Accepted**: If the conversion event is successfully queued for logging in the background. - **200 OK**: If the contact is not associated with the organisation, no conversion is logged, but the request is acknowledged. - **401 Unauthorized**: If the API key is invalid or missing, access is denied. ### Example Usage ```bash curl -X POST "https://services.meetchase.ai/api/v2/conversions" -H "X-API-Key: " -d '{ "email": "user@example.com", "conversion_type": "purchase", "conversion_data": { "item": "premium_subscription", "price": 99.99 } }' ``` # Start Campaign Source: https://docs.meetchase.ai/api-reference/endpoint/startCampaign PUT /api/v1/campaigns/{campaign_id}/start Initiates a specified campaign, marking it as active and beginning the exchanges. ### Path Parameters - `organisation_id` (`int`): The ID of the organisation under which the campaign is registered. - `campaign_id` (`int`): The unique identifier of the campaign to be started. ### Headers - `X-API-Key`: API key for user authentication. ### Response - Returns a confirmation message indicating that the campaign has been successfully started and will begin its operations imminently. ### Errors - `400 Bad Request`: If the campaign cannot be started due to missing or invalid campaign settings. - `403 Forbidden`: If the user making the request does not have the necessary permissions to start the campaign. - `404 Not Found`: The campaign does not belong to the specified organisation. # Add Contact Source: https://docs.meetchase.ai/api-reference/endpoint/uploadContact POST /api/v1/contacts/add Adds a new contact to the specified organisation. If the contact is already associated with the organisation, the endpoint return its ID. ### Request Body - `contact` (`ContactUpload`): The contact details to be uploaded. This includes email, first name, last name, and custom data. ### Headers - `X-API-Key`: The API key for authentication. ### Response - Returns the ID of the newly created contact. ### Errors - `400 Bad Request`: If the contact is already associated with the organisation. # Add Contact to Campaign Source: https://docs.meetchase.ai/api-reference/endpoint/uploadContactToCampaign POST /api/v1/campaigns/{campaign_id}/contacts/upload This endpoint first uplaods a contact, then adds them to a campaign. ### Path Parameters - campaign_id (`int`): The ID of the campaign to which the contacts are being added. ### Query Parameters - bot_id (`int`): (Optional) The ID of the bot responsible for managing the contact's email exchanges within the campaign. If not provided, the system will manually assign the contact to a bot. - notify (`bool`): A flag the users associated with the campaign should be notified about the new contact. Default is `True`. ### Request Body - contact (`ContactUpload`): An object containing the contact details to be added to the campaign. ### Headers `X-API-Key`: The API key for authenticating the request. ### Response `BaseItem`: The ID of the newly inserted contact. ### Errors - `400 Bad Request`: If the contact is already associated with the organisation or there are no bots in the organisation. - `401 Unauthorized`: If the API key is invalid. - `404 Not Found`: If the campaign does not exist or is not associated with the organisation. # Add Contact to Campaign & Start Source: https://docs.meetchase.ai/api-reference/endpoint/uploadContactToCampaignStart POST /api/v1/campaigns/{campaign_id}/contacts/upload-and-start This endpoint first uplaods a contact, then adds them to a campaign. ### Path Parameters - campaign_id (`int`): The ID of the campaign to which the contacts are being added. ### Query Parameters - **bot_id** (`int`): (Optional) The ID of the bot responsible for managing the contact's email exchanges within the campaign. - **start_immediately** (`bool`): A flag indicating whether emails should be immediately sent to the contact after adding. Default is `False` - will wait for an appropriate time. ### Request Body - contact (`ContactUpload`): An object containing the contact details to be added to the campaign. ### Headers `X-API-Key`: The API key for authenticating the request. ### Response `BaseItem`: The ID of the newly inserted contact. ### Errors - `400 Bad Request`: If the contact is already associated with the organisation or there are no bots in the organisation. - `401 Unauthorized`: If the API key is invalid. - `404 Not Found`: If the campaign does not exist or is not associated with the organisation. # How to Create an App Password for Gmail / Google Workspace Source: https://docs.meetchase.ai/guides/google-app-passwords A quick, secure way to connect your Gmail or Google Workspace mailbox to Mailivery using an app password. # How to Create an App Password for Gmail / Google Workspace Want to connect your Gmail or Google Workspace mailbox to Mailivery the secure way? You’re in the right place. This guide walks you through setting up an **App Password**—a one-time password that gives Mailivery access without sharing your main Google credentials. You’ll enable two-factor authentication, generate an app-specific password, and flip on IMAP. That’s it. Let’s get you set up in three quick steps: *** ## ✅ Step 1: Turn on Two-Factor Authentication 1. Go to your [Google Account settings](https://myaccount.google.com/). 2. Click **Security**. 3. Under **"How you sign in to Google"**, select **2-Step Verification**. 4. Follow the steps to turn it on. > Why this matters: App passwords only work if 2FA is enabled. Think of it as giving your mailbox a bodyguard. *** ## 🔐 Step 2: Generate an App Password for Mailivery Once 2FA is turned on: 1. In your Google Account, search for **App passwords**—or go [directly to the page](https://myaccount.google.com/apppasswords). 2. You may be asked to sign in again. 3. Don’t see the option? Your admin or account settings might be restricting access. *** ## ✏️ Step 3: Create and Name Your App Password 1. Under **Select App**, choose **Other (Custom name)**. 2. Type in `Mailivery`. 3. Click **Generate**. Google will give you a 16-character password. Copy it—**this is your golden ticket.** Use it when connecting your mailbox to Mailivery. No extra logins. No extra stress. *** ## 👀 Need the Full Picture? If you’re looking for the full mailbox connection walkthrough, we’ve got you covered: 👉 [How to Connect Any Gmail / Gsuite / Google Workspace Mailbox to Mailivery](#) *** And just like that, you’re securely connected. # Set Up Mailboxes Source: https://docs.meetchase.ai/guides/setup Learn how to create a look-alike domain, create AI SDR mailboxes and connect to ChaseLabs By sending emails from lookalike domains, you protect your main domain's sending reputation and mitigate risks to your company's regular operational email deliverability. If you run into issues whilst connecting please reach out to [elizabeth@meetchase.ai](mailto:elizabeth@meetchase.ai). Important Note: The only way we can guarantee complete protection to your primary domain is by using a look-alike domain. With that being said, unlike other platforms we focus on quality over quantity, building strong reputation, using high quality creative, and gold standard contact data. It is ultimately up to you whether you would like to use a secondary/look-alike domain or your core domain. Depending on your choice, please either go to step 1 or jump to 3. Use your domain provider to set up a new domain. Popular providers include [Amazon Web Services (AWS)](https://docs.aws.amazon.com/codeartifact/latest/ug/domain-create.html), [GoDaddy](https://www.godaddy.com/help/domains-1000003), and [Namecheap](https://www.namecheap.com/support/knowledgebase/category/34/domains/). A look-alike domain closely resembles your main domain but is distinct enough that automated systems do not recognize it as identical. For instance, if your primary domain is acmecorp.com you might create a cousin domain like heyacme.com or meetacme.com. We highly recommend using a .com or other high reputation top level domain. After setting up the domain, add the domain to your organisation workspace. Follow this [guide](https://knowledge.workspace.google.com/kb/how-to-add-a-secondary-domain-to-your-organization-000006216) to setup the domain in Google Workspace. Follow this [guide](https://learn.microsoft.com/en-us/microsoft-365/admin/setup/add-domain?view=o365-worldwide) to setup the domain in Microsoft 365. Configure the necessary DNS settings with your domain provider/mailbox provider to complete the setup process. 1. Add [SPF Record](https://support.google.com/a/answer/33786?product_name=UnuFlow\&visit_id=638786777375930107-1454187036\&rd=1\&src=supportwidget0#spf-add-record) | Record Type | Host | Value | | ----------- | ---- | ------------------------------------- | | TXT | @ | v=spf1 include:\_spf.google.com \~all | 2. Setup DKIM by following this [guide](https://support.google.com/a/answer/180504#dkim-turn-on-verify). 3. Setup DMARC by following this [guide](https://support.google.com/a/answer/2466580). 4. Add the following CNAME Record | Record Type | Host | Value | | ----------- | ---- | ----------- | | CNAME | data | chselbs.com | 5. Add an A or CNAME record that points to your main company website. 1. Add an [SPF Record](https://learn.microsoft.com/en-us/defender-office-365/email-authentication-spf-configure) to your DNS settings. 2. Setup DKIM by following this [guide](https://learn.microsoft.com/en-us/defender-office-365/email-authentication-dkim-configure). 3. Setup DMARC by following this [guide](https://learn.microsoft.com/en-us/defender-office-365/email-authentication-dmarc-configure). 4. Add the following CNAME Record | Record Type | Host | Value | | ----------- | ---- | ----------- | | CNAME | data | chselbs.com | 5. Add an A or CNAME record that points to your main company website. You can name these whatever you like! We highly recommend using a human sounding name and not your own. Perhaps swap the first and last names of your closest friends! Follow this [guide](https://knowledge.workspace.google.com/kb/how-to-create-a-new-user-000007668) to create a new user in Google Workspace. Make sure to use the new domain you setup for their email. Follow this [guide](https://learn.microsoft.com/en-us/microsoft-365/admin/add-users/add-users?view=o365-worldwide) to create a new user in Microsoft 365. Make sure to use the new domain you setup for their email. 1. Authenticate the new accounts by clicking "Add New SDR" under your [Organisation Settings](https://app.meetchase.ai/app/organisation-settings). Add New SDR 2. Alternatively you can share the email/passwords with [elizabeth@meetchase.ai](mailto:elizabeth@meetchase.ai) who will connect your accounts. Once connected our systems will automatically run a mailbox health test to ensure the accounts were setup correctly. # Introduction Source: https://docs.meetchase.ai/introduction Welcome to our API documentation ## Overview This guide will help you understand and integrate with our services. ## Need Help? If you need assistance, please: * Review our [API Reference](/api-reference) * Contact our support team