ClientSuccess is a customer success management platform that helps SaaS and subscription businesses onboard, retain, and grow their customer base. Its REST API provides programmatic access to clients, contacts, contracts, client notes, and customer health Pulse records, enabling teams to synchronize customer success data with their broader data ecosystem.
Power end-to-end data operations for your ClientSuccess API with Nexla. Our bi-directional ClientSuccess connector is purpose-built for ClientSuccess, 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 ClientSuccess or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your ClientSuccess 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
Access to the ClientSuccess API requires an active ClientSuccess account with permission to manage API keys. API access is configured from the ClientSuccess application settings, so you must be able to sign in to your ClientSuccess instance with sufficient permissions.
ClientSuccess recommends creating a dedicated user account named API Access to be used exclusively for API integrations. Using a dedicated account isolates integration activity from individual user accounts, making API usage easier to audit and manage. When naming this account, include "API Access" in the name so that it is not counted as a billable user seat.
Authentication to the ClientSuccess API is performed using an API key, which Nexla sends in the X-API-Key request header on every call. Generate your API key from within the ClientSuccess application:
Sign in to your ClientSuccess instance.
Navigate to the Settings area and open the API Keys section.
Create a new API key, and provide a descriptive name that identifies its intended use (for example, "Nexla Integration").
Copy the generated API key value and store it securely.
Important
Copy and securely store your API key immediately after generating it. Treat the key like a password—it grants programmatic access to your ClientSuccess data, and it may not be retrievable in full after the initial creation.
ClientSuccess API requests are issued against a base URL for your environment. The default base URL is https://api.clientsuccess.com/api. Some accounts use an instance-specific host in the form https://your-company.clientsuccess.com/api. Confirm the correct base URL for your account before configuring the credential.
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 ClientSuccess API base URL in the API Base URL field. This is the root URL against which all API requests are made. The default value is https://api.clientsuccess.com/api. If your account uses an instance-specific host, enter it in the form https://your-company.clientsuccess.com/api.
Enter your ClientSuccess API key in the API Key field. Nexla sends this value in the X-API-Key header to authenticate each request. This value is stored securely and should be kept confidential.
Nexla validates the credential against the ClientSuccess health endpoint when you save it. A successful validation confirms that the base URL and API key are correct and that Nexla can reach your ClientSuccess account.
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 and can be selected for use with a new data source or destination.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the ClientSuccess connector tile, then select the credential that will be used to connect to the ClientSuccess instance, and click Next; or, create a new ClientSuccess 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 ClientSuccess 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.
Search Pulses
This endpoint searches Pulse records, which represent point-in-time measurements of customer health and engagement in ClientSuccess. Use this endpoint to ingest Pulse data for monitoring account health trends and identifying at-risk clients.
This endpoint requires no configuration to return all accessible Pulse records. To narrow the results, optionally enter a value in the Client ID field to filter Pulses for a specific client, the Note field to filter by note content, or the Subject field to filter by subject.
The endpoint is paginated and automatically retrieves additional pages of results as needed, fetching up to 100 records per page.
Results are returned as an array under the response data property, and Nexla treats each element as an individual record.
Create Pulse
This endpoint creates a new Pulse record for a client. Use it to write customer health measurements into ClientSuccess as part of a data flow.
Enter the ID of the client this Pulse applies to in the Client ID field. This field is required.
Optionally provide additional Pulse details using the corresponding fields, including:
Note, Next Steps, and Subject for descriptive content.
Starting Score, Current Score, Total Score Change, and Last Score Change for health scoring.
Tenant ID, UUID, Disposition Type, Disposition ID, Created By Employee ID, Created Timestamp, Product ID, and Batch Update Timestamp for record metadata.
Because this endpoint writes data into ClientSuccess, use it within flows where the source records map cleanly to the Pulse fields you intend to populate.
Search Client Notes
This endpoint searches client notes, which capture interactions, comments, and activity logged against a client. Use it to ingest the full set of accessible client notes for analysis or archival.
This endpoint requires no additional configuration. Select it to retrieve all accessible client notes.
The endpoint is paginated and automatically retrieves additional pages of results as needed, fetching up to 100 records per page.
Results are returned as an array under the response data property, and Nexla treats each element as an individual record.
Create Client Note
This endpoint creates a new client note. Use it to write interaction records or activity logs into a client's history in ClientSuccess.
Provide the note content in the Note field and a Subject to summarize it, and identify the associated client using the Client ID field.
Optionally supply additional context and metadata using the corresponding fields, including:
Created By Employee ID, Author, Interaction Type ID, and Created Time / Modified Time for attribution and timing.
File Path, Source ID, Thread ID, and Properties for linking and custom data.
Tenant ID, External System, External System ID, and Account External System ID for external system mapping.
Update Client Note
This endpoint fully replaces an existing client note identified by its ID. Use it when you need to overwrite a note's contents in their entirety.
Enter the ID of the note to replace in the Id field. This value is appended to the request URL to target the specific note.
Provide the complete replacement values for the note, including the Note, Subject, Client Id, and any of the additional fields such as Author, Interaction Type Id, Created Time, Modified Time, and external system identifiers.
Because this is a full replacement (PUT), any field left empty will overwrite the corresponding existing value. Provide all values that should be retained.
Patch Client Note
This endpoint partially updates an existing client note identified by its ID. Use it when you need to modify only specific fields of a note without replacing the entire record.
Enter the ID of the note to update in the Id field. This value is appended to the request URL to target the specific note.
Provide only the fields you want to change, such as Note, Subject, Author, or any of the other available note fields.
Unlike Update Client Note, this endpoint performs a partial update (PATCH), so fields you do not supply are left unchanged.
Workato Bulk Upsert Client Notes
This endpoint upserts client notes in bulk through the ClientSuccess Workato integration endpoint. Use it to create or update many client notes in a single batch operation.
Optionally set the Logging Level field to control the verbosity of operation logging returned by the bulk request.
The note records to upsert are supplied from the incoming Nexset data, with each record mapped to the corresponding client note fields.
Create Client Note from Transcript
This endpoint generates a client note from a meeting transcript using AI summarization. Use it to automatically convert call or meeting transcripts into structured client notes.
Provide the meeting transcript text in the Transcript field.
Optionally supply the Host Email and Participants to attribute the meeting, the Additional Prompt to guide the AI summarization, and Custom Note Headers to control the structure of the generated note.
This endpoint is part of the ClientSuccess Workato integration and uses AI to produce the note content, so generated results may vary based on the transcript and the prompt provided.
Create Client
This endpoint creates a single new client record in ClientSuccess. Use it to add accounts that you want to track in your customer success program.
This endpoint takes the client details from the incoming Nexset data. Map the source record fields to the ClientSuccess client attributes you want to populate.
Bulk Create Clients
This endpoint creates multiple client records in a single request. Use it for efficient onboarding of many accounts at once.
The client records to create are supplied through the Add field, which carries the batch of clients from the incoming data.
Get Client
This endpoint retrieves a single client record by its UUID. Use it to fetch full details for a specific account.
Enter the UUID of the client to retrieve in the Client ID field. This value is appended to the request URL to target the specific client.
You can obtain client UUIDs from the Search Pulses, Search Client Notes, or other client-related responses, or from the ClientSuccess application.
Create Contact
This endpoint creates a new contact associated with a client. Use it to add the individuals you work with at each account.
This endpoint takes the contact details from the incoming Nexset data. Map the source record fields to the ClientSuccess contact attributes you want to populate.
Get Contact
This endpoint retrieves a single contact record by its UUID. Use it to fetch full details for a specific contact.
Enter the UUID of the contact to retrieve in the Contact ID field. This value is appended to the request URL to target the specific contact.
Update Contact
This endpoint fully replaces an existing contact record identified by its UUID. Use it to overwrite a contact's details in their entirety.
Enter the UUID of the contact to update in the Contact ID field. This value is appended to the request URL to target the specific contact.
Provide the complete replacement contact details from the incoming data.
Because this is a full replacement (PUT), any value not supplied will overwrite the corresponding existing field. Provide all values that should be retained.
Patch Contact
This endpoint partially updates an existing contact record identified by its UUID. Use it to modify only specific contact fields without replacing the entire record.
Enter the UUID of the contact to update in the Contact ID field. This value is appended to the request URL to target the specific contact.
Provide only the contact fields you want to change from the incoming data.
Search Contacts
This endpoint searches contact records with optional filtering. Use it to ingest contacts across your accounts.
Optionally use the available filter fields to narrow the returned contacts to those matching your criteria.
The endpoint is paginated and automatically retrieves additional pages of results as needed.
Bulk Create Contacts
This endpoint creates multiple contact records in a single request. Use it for efficient bulk loading of contacts.
The contact records to create are supplied from the incoming Nexset data as a batch.
Upsert Batch Contacts (Workato)
This endpoint creates or updates contacts in bulk through the ClientSuccess Workato integration endpoint. Use it to synchronize a batch of contacts where some may already exist.
The contact records to upsert are supplied from the incoming Nexset data as a batch. Existing contacts are updated and new contacts are created based on the matching keys in your data.
Upsert Contact
This endpoint creates or updates a single contact in one operation. Use it when you want to insert a contact if it does not already exist, or update it if it does.
The contact details are supplied from the incoming Nexset data. Existing contacts are matched and updated, and new contacts are created.
Create Contract
This endpoint creates a new contract record. Use it to record subscription or agreement details for a client.
The contract details are supplied from the incoming Nexset data. Map the source record fields to the ClientSuccess contract attributes you want to populate.
Get Contract
This endpoint retrieves a single contract record by its ID. Use it to fetch the full details of a specific contract.
Enter the ID of the contract to retrieve in the Contract ID field. This value is appended to the request URL to target the specific contract.
Update Contract
This endpoint fully replaces an existing contract record identified by its ID. Use it to overwrite a contract's details in their entirety.
Enter the ID of the contract to update in the Contract ID field. This value is appended to the request URL to target the specific contract.
Provide the complete replacement contract details from the incoming data.
Because this is a full replacement (PUT), any value not supplied will overwrite the corresponding existing field. Provide all values that should be retained.
Search Contracts
This endpoint searches contract records. Use it to ingest contracts across your accounts for revenue and renewal reporting.
This endpoint requires no additional configuration. Select it to retrieve all accessible contracts.
Add Contract Items
This endpoint adds line items to an existing contract. Use it to append products, services, or other items to a contract.
Enter the ID of the target contract in the Contract ID field. This value is appended to the request URL to target the specific contract.
Provide the items to add from the incoming Nexset data.
Update Contract Items
This endpoint updates existing line items on a contract. Use it to modify quantities, values, or other details of items already on a contract.
Enter the ID of the target contract in the Contract ID field. This value is appended to the request URL to target the specific contract.
Provide the updated item details from the incoming Nexset data.
Search Contract Notes
This endpoint searches the notes associated with a specific contract. Use it to ingest commentary and activity recorded against a contract.
Enter the ID of the target contract in the Contract ID field. This value is appended to the request URL to scope the search to that contract.
Search Contract Attachments
This endpoint searches the attachments associated with a specific contract. Use it to ingest metadata about files attached to a contract.
Enter the ID of the target contract in the Contract ID field. This value is appended to the request URL to scope the search to that contract.
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.
ClientSuccess data sources can also be manually configured to ingest data from any valid ClientSuccess 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.
ClientSuccess API requests are issued against the base URL described in Prerequisites, with the endpoint path appended after it—for example, https://api.clientsuccess.com/api/v1/clientNote/search.
ClientSuccess search endpoints return an array of records under a top-level data property alongside pagination metadata, so enter $.data[*] as the path to data for these responses.
You do not need to include the X-API-Key header—Nexla attaches it automatically from your credential.
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 ClientSuccess 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 ClientSuccess destination, and select the Send to Destination option from the menu. Select the ClientSuccess connector from the list of available destination connectors, then select the credential that will be used to connect to the ClientSuccess organization, and click Next; or, create a new ClientSuccess credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common ClientSuccess 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.
Delete Contact
This endpoint deletes a contact from ClientSuccess by its UUID. Use it to remove contacts that are no longer valid, keeping your customer success data clean and current.
Enter the UUID of the contact to delete in the Contact ID field. This value is required and is appended to the request URL to target the specific contact to be removed.
The contact UUID is typically supplied from the incoming Nexset data. Map the field in your Nexset that holds the contact UUID to the Contact ID parameter.
Contact deletion is permanent. Verify that the UUIDs being sent correspond to the contacts you intend to remove before activating the destination.
ClientSuccess destinations can also be manually configured to send data to any valid ClientSuccess API endpoint. This is useful for write operations not covered by the pre-built template, such as creating clients, contacts, contracts, or client notes, or for applying custom request configurations. 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.
ClientSuccess accepts JSON for all destination operations. Endpoints are appended to the base URL described in Prerequisites—for example, https://api.clientsuccess.com/api/v1/contact. For update, patch, or delete operations, include the ID of the object to be modified at the end of the URL (e.g., https://api.clientsuccess.com/api/v1/contact/{contact_id}).
Enable record batching for the ClientSuccess bulk and upsert endpoints (such as Bulk Create Clients, Bulk Create Contacts, Upsert Batch Contacts (Workato), and Workato Bulk Upsert Client Notes), which accept multiple records in a single request.
You do not need to include the X-API-Key header—Nexla attaches it automatically from your credential.
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 ClientSuccess endpoint, open the destination resource menu, and select Activate.
The Nexset data will not be sent to the ClientSuccess endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.
