Customerly is an AI-powered customer support and engagement platform for SaaS companies, combining live chat, a unified inbox, support automation, email marketing, NPS/CSAT surveys, and a knowledge base. Its Aura AI agent resolves many inquiries automatically, escalating complex cases to humans. The REST API manages users, leads, accounts, tags, messages, and knowledge base content.
Power end-to-end data operations for your Customerly API with Nexla. Our bi-directional Customerly connector is purpose-built for Customerly, 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 Customerly or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Customerly 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
To connect Nexla to your Customerly account, you need a Customerly API access token. Customerly uses API key authentication, where your token is transmitted as a Bearer token in the Authentication request header for every API call.
Click the Settings icon in the bottom-left sidebar to open the Project Settings.
Navigate to Installation in the settings menu.
Scroll down to the Public API section. Your unique access token is displayed in the field labeled Your Access Token for Customerly.
Copy the token value — you will enter it in the Nexla credential form.
Important
Keep your API access token confidential. Anyone who has access to this token can make API calls on behalf of your Customerly workspace. Do not share it publicly or commit it to source control.
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
Enter your Customerly API access token in the API Key field. Nexla will include this token as a Bearer token in the Authentication header of all requests sent to the Customerly API (Authentication: Bearer <your_token>).
This token authenticates Nexla with your Customerly workspace and grants access to all resources available through your account. Nexla stores the token securely and uses it exclusively for API calls made on your behalf.
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.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Customerly connector tile, then select the credential that will be used to connect to the Customerly instance, and click Next; or, create a new Customerly credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Customerly 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. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.
List Users
Returns a paginated list of all users in your Customerly workspace. Use this endpoint when you need to export or analyze your full user base, including their contact details, attributes, and subscription status.
This endpoint automatically retrieves all users in your account using page-based pagination. Nexla fetches pages incrementally (50 records per page by default) until no further results are returned.
No additional parameters are required beyond selecting this endpoint template.
Users in Customerly are contacts who have been identified by their user ID or email address — typically authenticated customers of your product. To retrieve anonymous visitors, use the List Leads endpoint instead.
List Leads
Returns a paginated list of all leads in your Customerly workspace. Leads are anonymous or unidentified visitors who have interacted with your chat widget but have not yet been identified as users.
This endpoint automatically retrieves all leads using page-based pagination. Nexla fetches pages incrementally (50 records per page by default) until no further results are returned.
No additional parameters are required beyond selecting this endpoint template.
Once a lead is converted or identified, they become a user in Customerly. Use this endpoint to analyze pre-conversion contact data or track lead volume over time.
Get User by Email
Returns full profile details for a single Customerly user identified by their email address. Use this endpoint when you need to look up a specific user's data for enrichment, verification, or targeted processing.
Enter the email address of the user to look up in the Email field. This is a required parameter.
The email address must match exactly the email stored in Customerly for the user.
The response returns the full user profile, including custom attributes, subscription status, and company associations.
This endpoint returns a single user record rather than a paginated list. It is best suited for targeted lookups or when building flows that process individual users based on a known email address.
Get User by ID
Returns full profile details for a single Customerly user identified by their user ID. Use this endpoint when you have a Customerly user ID and need to retrieve all associated data for that user.
Enter the unique identifier of the user in the User ID field. This is a required parameter.
The user ID is the identifier you assigned to the user when they were created in Customerly (typically your internal application user ID).
The response returns the full user profile, including custom attributes, subscription status, and company associations.
This endpoint returns a single user record. Use it in flows where you already have a known user ID, such as when joining Customerly user data with records from another system.
List Accounts
Returns the list of accounts (admins and teammates) in your Customerly workspace. Use this endpoint to retrieve information about the support agents and team members who manage your Customerly inbox.
This endpoint retrieves all accounts in a single request without pagination. No additional configuration is required beyond selecting this endpoint template.
The response includes each account's ID, name, email address, role, and avatar information.
Accounts represent the internal team members of your Customerly workspace — not your customers. Use this endpoint to sync agent rosters or audit team membership.
Get Lead by Email
Returns full profile details for a single Customerly lead identified by their email address. Use this endpoint when you need to look up a specific lead for enrichment or targeted processing.
Enter the email address of the lead in the Email field. This is a required parameter.
The email address must match exactly the email stored in Customerly for the lead.
The response returns the full lead profile, including any collected attributes and conversation history.
This endpoint returns a single lead record. It is best suited for targeted lookups when you have a specific lead's email address and need to retrieve their associated data.
List Tags
Returns the list of all tags defined in your Customerly workspace. Tags are labels that can be applied to users and leads to organize and segment your contacts.
This endpoint retrieves all tags in a single request without pagination. No additional configuration is required beyond selecting this endpoint template.
The response includes each tag's ID, name, and associated metadata.
Use this endpoint to audit your tag taxonomy, synchronize tags to external systems, or build flows that enrich contact records with tag information.
List Knowledge Base Collections
Returns the list of all knowledge base collections in your Customerly workspace. Collections are top-level categories that group related knowledge base articles.
This endpoint retrieves all collections in a single request without pagination. No additional configuration is required beyond selecting this endpoint template.
The response includes each collection's ID, title, description, icon, and slug.
Use this endpoint to replicate your knowledge base structure to an external system or to build flows that process articles grouped by collection.
Get Knowledge Base Collection
Returns details for a single knowledge base collection identified by its ID. Use this endpoint when you need to retrieve complete metadata for a specific collection.
Enter the unique identifier of the collection in the Collection ID field. This is a required parameter.
Collection IDs can be found by first using the List Knowledge Base Collections endpoint to retrieve all collections and their corresponding IDs.
The response returns the full collection record, including title, description, icon, and slug.
This endpoint returns a single collection record. Use it when you already have a known collection ID and need to retrieve or validate its metadata.
List Knowledge Base Articles
Returns the list of all knowledge base articles in your Customerly workspace. Use this endpoint to export your entire knowledge base content for analysis, backup, or synchronization with an external system.
This endpoint retrieves all articles in a single request without pagination. No additional configuration is required beyond selecting this endpoint template.
The response includes each article's ID, title, body content, collection association, slug, and publication status.
Use this endpoint to replicate your knowledge base content to an external CMS, data warehouse, or search index.
Get Knowledge Base Article
Returns details for a single knowledge base article identified by its ID. Use this endpoint when you need to retrieve the full content and metadata for a specific article.
Enter the unique identifier of the article in the Article ID field. This is a required parameter.
Article IDs can be found by first using the List Knowledge Base Articles endpoint to retrieve all articles and their corresponding IDs.
The response returns the full article record, including title, body content, collection ID, slug, and publication status.
This endpoint returns a single article record. Use it when you already have a known article ID and need to retrieve or validate its content.
List Knowledge Base Writers
Returns the list of knowledge base writers (authors) in your Customerly workspace. Writers are the team members who have contributed articles to your knowledge base.
This endpoint retrieves all writers in a single request without pagination. No additional configuration is required beyond selecting this endpoint template.
The response includes each writer's ID, name, and associated profile information.
Use this endpoint to identify and sync knowledge base authors, or to enrich article records with author profile information from your Customerly workspace.
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.
Customerly data sources can also be manually configured to ingest data from any valid Customerly API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or sources that require 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.
The Customerly REST API base URL is https://api.customerly.io/v1/. Paginated list endpoints such as List Users and List Leads nest records under a data key (e.g., $.data.users[*] and $.data.leads[*]), while other list endpoints such as List Tags, List Accounts, and the knowledge base endpoints return arrays directly at $.data[*]; single-record endpoints (such as Get User by Email) return the object at $.data. You do not need to add the Authentication header manually — Nexla automatically includes your Customerly Bearer token from the configured credential in all API requests. For the complete endpoint reference, see the Customerly REST API reference.
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 Customerly 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.
Click the + icon on the Nexset that will be sent to the Customerly destination, and select the Send to Destination option from the menu. Select the Customerly connector from the list of available destination connectors, then select the credential that will be used to connect to the Customerly workspace, and click Next; or, create a new Customerly credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Customerly 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.
Create User
Creates a new user in your Customerly workspace. Use this endpoint to push identified user records from external systems — such as your application database, CRM, or data warehouse — into Customerly as tracked users.
This endpoint sends the Nexset record payload as a JSON body via HTTP POST to https://api.customerly.io/v1/users.
The JSON payload should include the following fields:
user_id (required): Your internal identifier for the user. This is used by Customerly to uniquely identify users across your product.
email: The user's email address.
name: The user's full name.
attributes: An object containing any custom user attributes you want to associate with the user in Customerly.
No additional template parameters are required. Map your Nexset fields to the appropriate JSON properties using Nexla's data transformation features before sending to this destination.
If a user with the given user_id already exists in Customerly, the API will update the existing user record rather than creating a duplicate. This makes the Create User endpoint suitable for upsert operations.
Delete User by ID
Deletes a user from your Customerly workspace by their user ID. Use this endpoint when you need to remove users from Customerly as part of an automated data lifecycle or compliance workflow.
Enter the unique identifier of the user to delete in the User ID field. This is a required parameter.
The default value is {'{'}{'{'}}user_id{'}'}{'}'} — map this to the appropriate field in your Nexset if your records use a different field name for the user identifier.
The user ID is appended as a query parameter to the DELETE request URL.
Deleting a user from Customerly is a permanent action. Ensure that the user ID values in your Nexset correspond to the correct Customerly users before activating this destination.
Unsubscribe User
Marks a user as unsubscribed from messaging in Customerly, preventing future automated messages from being sent to them. Use this endpoint to honor unsubscribe requests or sync opt-out status from an external suppression list.
Enter the unique identifier of the user to unsubscribe in the User ID field. This is a required parameter.
The default value is {'{'}{'{'}}user_id{'}'}{'}'} — map this to the appropriate field in your Nexset if your records use a different field name for the user identifier.
The user ID is included in the POST request URL path.
Unsubscribing a user suppresses automated campaign messages but does not prevent manual messages sent by support agents. This is suitable for managing marketing communication preferences.
Add User to Company
Associates an existing Customerly user with a company record. Use this endpoint when you need to link users to their organizations based on company data from an external CRM or database.
This endpoint sends a JSON body containing the user-to-company mapping via HTTP POST to https://api.customerly.io/v1/users/add-to-company.
The JSON payload should include the following fields:
user_id (required): The unique identifier of the user to associate.
company_id (required): The unique identifier of the company to associate the user with.
No additional template parameters are required. Map your Nexset fields to the appropriate JSON properties before sending to this destination.
Both the user and the company must already exist in Customerly before using this endpoint. If the company does not exist, create it first using the Customerly API before running this association flow.
Add User Attributes
Adds or updates custom attributes on a Customerly user. Use this endpoint to enrich user profiles with data from external systems, such as subscription tier, product usage metrics, or account health scores.
Enter the unique identifier of the user to update in the User ID field. This is a required parameter.
The default value is {'{'}{'{'}}user_id{'}'}{'}'} — map this to the appropriate field in your Nexset if your records use a different field name for the user identifier.
The user ID is included in the POST request URL path.
The request body should contain a JSON object with the attributes to set or update on the user. Each key-value pair in the body corresponds to a custom attribute name and its new value.
Custom attributes must be defined in your Customerly workspace before they can be set via the API. Refer to the Customerly settings for managing your attribute definitions.
Create Lead
Creates a new lead in your Customerly workspace. Use this endpoint to push anonymous or pre-identified visitor records from external systems into Customerly for tracking and engagement.
This endpoint sends the Nexset record payload as a JSON body via HTTP POST to https://api.customerly.io/v1/leads.
The JSON payload should include the following fields:
email: The lead's email address.
name: The lead's full name.
attributes: An object containing any custom lead attributes to associate with this record.
No additional template parameters are required. Map your Nexset fields to the appropriate JSON properties before sending to this destination.
Leads are distinct from users in Customerly. Use this endpoint for pre-conversion contacts. Once a lead is identified or converts, they can be promoted to a user using the Create User endpoint.
Delete Lead by Email
Deletes a lead from your Customerly workspace by their email address. Use this endpoint to remove leads as part of an automated data hygiene or GDPR compliance workflow.
Enter the email address of the lead to delete in the Email field. This is a required parameter.
The default value is {'{'}{'{'}}email{'}'}{'}'} — map this to the appropriate field in your Nexset if your records use a different field name for the email address.
The email address is appended as a query parameter to the DELETE request URL.
Deleting a lead from Customerly is a permanent action. Verify that the email values in your Nexset correspond to the correct Customerly leads before activating this destination.
Create Tag
Creates a new tag in your Customerly workspace and optionally assigns it to specified users or leads. Use this endpoint to programmatically manage your contact segmentation taxonomy.
This endpoint sends the Nexset record payload as a JSON body via HTTP POST to https://api.customerly.io/v1/tags.
The JSON payload should include the following fields:
name (required): The name of the tag to create.
user_ids (optional): An array of user IDs to assign the tag to immediately upon creation.
lead_ids (optional): An array of lead IDs to assign the tag to immediately upon creation.
No additional template parameters are required. Map your Nexset fields to the appropriate JSON properties before sending to this destination.
Tag names must be unique within your Customerly workspace. Attempting to create a tag with a name that already exists may result in an error or a duplicate entry, depending on your workspace configuration.
Delete Tag
Deletes a tag from your Customerly workspace. Use this endpoint to remove obsolete or unused tags as part of an automated workspace maintenance workflow.
This endpoint sends a JSON body containing the tag name via HTTP DELETE to https://api.customerly.io/v1/tags.
The JSON payload should include the following field:
name (required): The name of the tag to delete.
No additional template parameters are required. Map your Nexset field containing the tag name to the appropriate JSON property before sending to this destination.
Deleting a tag removes it from all users and leads it was previously assigned to. This action is permanent and cannot be undone.
Send Message to User
Sends a message to a Customerly user. Use this endpoint to trigger personalized in-app or email messages programmatically based on user behavior, data events, or external system triggers.
This endpoint sends the Nexset record payload as a JSON body via HTTP POST to https://api.customerly.io/v1/messages.
The JSON payload should include the following fields:
user_id (required): The unique identifier of the user who will receive the message.
content (required): The message body text.
type (required): The message type — for example, chat for in-app messages or email for email messages.
No additional template parameters are required. Map your Nexset fields to the appropriate JSON properties before sending to this destination.
Messages sent via the API are delivered on behalf of your Customerly workspace. The message will appear in the user's conversation thread and in the Customerly inbox. Ensure that the user is not unsubscribed before sending, as messages to unsubscribed users may not be delivered.
Create Knowledge Base Collection
Creates a new knowledge base collection in your Customerly workspace. Use this endpoint to programmatically build or replicate your knowledge base structure from an external content management system.
This endpoint sends the Nexset record payload as a JSON body via HTTP POST to https://api.customerly.io/v1/knowledge/collections.
The JSON payload should include the following fields:
title (required): The display title of the collection.
description: A brief description of the collection's content.
icon: An emoji or icon identifier for the collection.
slug: A URL-friendly identifier for the collection.
No additional template parameters are required. Map your Nexset fields to the appropriate JSON properties before sending to this destination.
Collection slugs must be unique within your Customerly workspace. If a slug is not provided, Customerly will generate one automatically based on the collection title.
Update Knowledge Base Collection
Updates an existing knowledge base collection in your Customerly workspace. Use this endpoint to sync collection metadata changes from an external system into Customerly.
Enter the unique identifier of the collection to update in the Collection ID field. This is a required parameter.
The default value is {'{'}{'{'}}knowledge_base_collection_id{'}'}{'}'} — map this to the appropriate field in your Nexset.
The collection ID is included in the POST request URL path.
The request body should contain a JSON object with the collection fields to update. You may send a partial payload containing only the fields you wish to change.
Collection IDs can be retrieved using the List Knowledge Base Collections data source endpoint. Use the Get Knowledge Base Collection source endpoint to verify the current state of a collection before updating it.
Delete Knowledge Base Collection
Deletes a knowledge base collection from your Customerly workspace by its ID. Use this endpoint to remove obsolete collections as part of an automated content lifecycle workflow.
Enter the unique identifier of the collection to delete in the Collection ID field. This is a required parameter.
The default value is {'{'}{'{'}}knowledge_base_collection_id{'}'}{'}'} — map this to the appropriate field in your Nexset.
The collection ID is included in the DELETE request URL path.
Deleting a collection may also affect the articles within it, depending on your Customerly workspace configuration. Review collection contents before deleting to avoid unintended data loss.
Create Knowledge Base Article
Creates a new knowledge base article in your Customerly workspace. Use this endpoint to programmatically publish support content from an external CMS or content pipeline into Customerly.
This endpoint sends the Nexset record payload as a JSON body via HTTP POST to https://api.customerly.io/v1/knowledge/articles.
The JSON payload should include the following fields:
title (required): The display title of the article.
body (required): The HTML or plain text content of the article.
collection_id (required): The ID of the collection this article belongs to.
slug: A URL-friendly identifier for the article.
No additional template parameters are required. Map your Nexset fields to the appropriate JSON properties before sending to this destination.
Article slugs must be unique within your Customerly workspace. If a slug is not provided, Customerly will generate one automatically based on the article title. Use the List Knowledge Base Collections source endpoint to retrieve valid collection IDs.
Update Knowledge Base Article
Updates an existing knowledge base article in your Customerly workspace. Use this endpoint to sync article content changes from an external content management system into Customerly.
Enter the unique identifier of the article to update in the Article ID field. This is a required parameter.
The default value is {'{'}{'{'}}knowledge_base_article_id{'}'}{'}'} — map this to the appropriate field in your Nexset.
The article ID is included in the POST request URL path.
The request body should contain a JSON object with the article fields to update. You may send a partial payload containing only the fields you wish to change.
Article IDs can be retrieved using the List Knowledge Base Articles data source endpoint. Use the Get Knowledge Base Article source endpoint to verify the current content of an article before updating it.
Delete Knowledge Base Article
Deletes a knowledge base article from your Customerly workspace by its ID. Use this endpoint to remove outdated or incorrect content as part of an automated knowledge base maintenance workflow.
Enter the unique identifier of the article to delete in the Article ID field. This is a required parameter.
The default value is {'{'}{'{'}}knowledge_base_article_id{'}'}{'}'} — map this to the appropriate field in your Nexset.
The article ID is included in the DELETE request URL path.
Deleting a knowledge base article is a permanent action and cannot be undone. Verify that the article ID values in your Nexset correspond to the correct articles before activating this destination.
Add Company Attributes
Adds or updates custom attributes on a Customerly company record. Use this endpoint to enrich company profiles with data from external systems, such as industry, revenue, or account health scores.
Enter the unique identifier of the company to update in the Company ID field. This is a required parameter.
The default value is {'{'}{'{'}}company_id{'}'}{'}'} — map this to the appropriate field in your Nexset.
The company ID is included in the POST request URL path.
The request body should contain a JSON object with the attributes to set or update on the company. Each key-value pair corresponds to a custom attribute name and its new value.
Custom company attributes must be defined in your Customerly workspace before they can be set via the API. Refer to the Customerly settings for managing your company attribute definitions.
Customerly destinations can also be manually configured to send data to any valid Customerly 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.
The Customerly API accepts JSON for all write operations, using the base URL https://api.customerly.io/v1/ followed by the resource path. For update or delete operations, include the record's ID at the end of the URL (for example, https://api.customerly.io/v1/knowledge/articles/12345). You do not need to add the Authentication header manually — Nexla automatically includes your Customerly Bearer token from the configured credential in all API requests. Most Customerly API write endpoints accept a single record per request; review the Customerly API documentation to confirm whether batch payloads are supported for a specific endpoint.
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 Customerly endpoint, open the destination resource menu, and select Activate.
The Nexset data will not be sent to the Customerly endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.
