Smartreach

SmartReach is a multichannel sales engagement and cold outreach platform for running email, call, LinkedIn, WhatsApp, and SMS campaigns. Its REST API exposes campaigns, prospects, engagement statistics, and account settings, and lets you add or update prospects, enroll them in campaigns, and manage your do-not-contact blocklist. This connector uses SmartReach's v3 API with API key authentication.

Power end-to-end data operations for your Smartreach API with Nexla. Our bi-directional Smartreach connector is purpose-built for Smartreach, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Smartreach or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Smartreach workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a SmartReach credential, you need your API Key and Team ID. SmartReach authenticates API requests with a user-level API key passed in the X-API-KEY header, and most endpoints require a team_id to identify the team context in which the request runs.

To obtain your SmartReach credentials, follow these steps:

1. Sign in to your SmartReach account at smartreach.io.

2. Navigate to Settings > Team Settings > Integrations.

3. Under the API Key section, locate your User-Level API Key. This key begins with the prefix uk_ (for "user key"). If no key exists yet, generate one.

4. On the same Integrations page, locate your Team ID. This value begins with the prefix team_ and is required on nearly every SmartReach API call.

5. Copy both values and store them securely, as you will need them to configure your Nexla credential.

API keys are user-specific and carry the permissions of the user account that owns them. Because a user can belong to multiple teams, the Team ID ensures each request is executed within the correct team. Keep your API key confidential, and regenerate it with caution, as regenerating the key can disrupt existing integrations. For detailed information about authentication and available endpoints, see the SmartReach API Reference.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key	Yes	Yes	Your SmartReach API key (found in Settings -> Team Settings -> Integrations). Begins with the prefix 'uk_'.
Team ID	Yes	No	Your SmartReach team ID (found in Settings -> Team Settings -> Integrations). Begins with the prefix 'team_'. Required on nearly every SmartReach API call.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your SmartReach API key in the API Key field. This is the user-level key beginning with uk_ that you obtained in Prerequisites. It is sent in the X-API-KEY header for all API requests and must be kept confidential.

4. Enter your SmartReach team ID in the Team ID field. This is the value beginning with team_ that identifies the team context for your requests.

   API keys are user-specific and carry the permissions of the user account that owns them. If your API key is compromised, regenerate it in Settings > Team Settings > Integrations, but note that regenerating the key can disrupt existing integrations.

   For detailed information about authentication and available endpoints, see the SmartReach API Reference.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Smartreach connector tile, then select the credential that will be used to connect to SmartReach, and click Next; or, create a new Smartreach credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common SmartReach endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Campaigns

Retrieve all campaigns for the team.

This endpoint returns the campaigns configured for the team identified by your credential's Team ID. Results are paginated, and Nexla automatically follows the pagination links to fetch subsequent pages.

[Rest API] Get Campaign

Retrieve a single campaign by ID.

• Campaign ID (required): The ID of the campaign to retrieve.

[Rest API] List Prospects

Retrieve prospects for the team.

Results are paginated, and Nexla automatically follows the pagination links to fetch subsequent pages.

[Rest API] Get Campaign Prospects

Retrieve prospects enrolled in a specific campaign, including per-prospect engagement status (sent, opened, replied, clicked, bounced).

• Campaign ID (required): The ID of the campaign whose prospects should be retrieved.

Results are paginated, and Nexla automatically follows the pagination links to fetch subsequent pages.

[Rest API] Get Campaign Stats

Retrieve engagement statistics for a campaign, including sent, opened, clicked, replied counts and reply sentiment breakdown.

• Campaign ID (required): The ID of the campaign whose statistics should be retrieved.

[Rest API] Get Campaign Channel Settings

Retrieve channel (email/call/LinkedIn/WhatsApp/SMS) settings configured for a campaign.

• Campaign ID (required): The ID of the campaign whose channel settings should be retrieved.

[Rest API] List Email Settings

Retrieve all sender email accounts configured for the account.

Results are paginated, and Nexla automatically follows the pagination links to fetch subsequent pages.

[Rest API] Get Do Not Contact List

Retrieve the account's do-not-contact (blocklist) entries.

Results are paginated, and Nexla automatically follows the pagination links to fetch subsequent pages.

[Rest API] List Teams

Retrieve teams accessible to the authenticated user.

Results are paginated, and Nexla automatically follows the pagination links to fetch subsequent pages.

[Rest API] List Users

Retrieve users belonging to a team.

Results are paginated, and Nexla automatically follows the pagination links to fetch subsequent pages.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

SmartReach data sources can also be manually configured to ingest data from any valid SmartReach API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new SmartReach data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the SmartReach destination, and select the Send to Destination option from the menu. Select the Smartreach connector from the list of available destination connectors, then select the credential that will be used to connect to SmartReach, and click Next; or, create a new Smartreach credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common SmartReach endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create or Update Prospect

Add a new prospect or update an existing prospect in your SmartReach account.

• Each record from your Nexset is sent as JSON in the request body to create or update a prospect. Ensure your record fields match the format required by the SmartReach API.

[Rest API] Add Prospect to Campaign

Add one or more prospects to a specific campaign by campaign ID.

• Campaign ID (required): The ID of the campaign to add prospects to.

[Rest API] Update Campaign Status

Start, stop, or schedule a campaign by campaign ID.

• Campaign ID (required): The ID of the campaign to update.

[Rest API] Update Prospect Status

Update the status (replied/pause/unpause/resume_later) of prospects within campaigns.

• Each record from your Nexset is sent as JSON in the request body. Ensure your record fields match the format required by the SmartReach API.

[Rest API] Add Emails to Blocklist

Add one or more email addresses to the do-not-contact blocklist.

• Each record from your Nexset is sent as JSON in the request body. Ensure your record fields match the format required by the SmartReach API.

Manual configuration

SmartReach destinations can also be manually configured to send data to any valid SmartReach API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured SmartReach endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the SmartReach endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.