LogoSimply SendDOCS
    Security
    npm package

    Authentication

    Simply Send uses API keys to authenticate requests. Learn how to generate and use them securely.

    Header Authentication

    All API requests must include your Account ID and the specific API key corresponding to the endpoint you are calling:

    • Transactional Email API (tapi.simplysend.email): Requires your Transactional API Key.
    • Marketing Email API (mapi.simplysend.email): Requires your Marketing API Key.
    • Web Setup / Resource Management API (wapi.simplysend.email/web-setup): Requires your Web Setup API Key (or alias).
    X-Api-Keyyour_endpoint_specific_api_key
    X-Idyour_account_id

    Obtaining Credentials

    To authenticate your requests, you'll need to retrieve both an API Key and your Account ID from you dashboard.

    1. API Keys

    You can manage your API keys in the Developer Settings section of your dashboard.

    How to get your API Key:

    1. Log in to your Simply Send Dashboard.
    2. Navigate to the API Keys page in the developer settings.
    3. Click on Generate New Key.
    4. Select the appropriate key type (Transactional, Marketing, or Web Setup) and copy the generated key.

    There are three types of API keys:

    Transactional

    For sending individual, time-sensitive emails.

    Marketing

    For campaigns and bulk newsletters.

    Web Setup

    For managing domains and configurations.

    2. Account ID (X-Id)

    Your Account ID uniquely identifies your workspace and is required for all API requests alongside your API Key.

    How to get your Account ID (X-Id):

    1. Log in to your Simply Send Dashboard.
    2. Navigate to the Account page.
    3. Locate your Account ID in the profile section and copy the value.

    Never share your API Keys

    Your API keys carry significant privileges. Never include them in client-side code, public repositories, or unencrypted storage. If a key is compromised, rotate it immediately in the dashboard.