Skip to main content

Capsule CRM

Capsule CRM is a customer relationship management platform that helps businesses track contacts, sales opportunities, projects, and tasks in one place. The Capsule API (v2) exposes this data over REST, letting you extract parties, opportunities, pipelines, tasks, and related CRM records for reporting, analytics, and integration.

Capsule CRM icon

Power end-to-end data operations for your Capsule CRM API with Nexla. Our bi-directional Capsule CRM connector is purpose-built for Capsule CRM, 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 Capsule CRM or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Capsule CRM 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​

Nexla connects to the Capsule API v2 (https://api.capsulecrm.com/api/v2) with a Capsule Personal Access Token, which Nexla sends as a bearer token in the Authorization header. Personal Access Tokens are tied to the Capsule user who creates them, so Nexla can read and change only what that user can.

To generate a Personal Access Token:

  1. Sign in to your Capsule CRM account.

  2. Open My Preferences > API Authentication Tokens.

  3. Under Personal Access Tokens, generate a new token, and copy its value. Store it securely; it grants access to your Capsule data.

If you plan to use Capsule CRM as a destination, the token must allow writes. Capsule rejects writes made with a read-only token, and operations that need administrator rights made by a non-administrator, with HTTP 403 (Requires additional scope). Several destination templates below, such as creating lost reasons, boards, or stages, need a Capsule administrator. Tokens you no longer need can be revoked from the same API Authentication Tokens page. For details, see Capsule's Authentication guide.

Capsule API rate limits

Capsule allows each user up to 4,000 API requests per hour for bearer-token requests, and returns HTTP 429 once the limit is reached until the window resets. Listing large accounts uses one request per page of 100 records, and each destination record is one request. See Capsule's rate limit documentation.

Authenticate​

Credentials required​

FieldRequiredSecretDescription
API KeyYesYesAPI key.

The API Key is your Capsule Personal Access Token.

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 Capsule Personal Access Token in the API Key field. The field is masked. Enter the token only, without a Bearer prefix; Nexla adds the prefix when it calls the Capsule API.

    If your Personal Access Token is compromised, revoke it from My Preferences > API Authentication Tokens in Capsule, generate a new one, and update the credential.

  4. 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.

Nexla tests the credential by reading the Capsule user that the token belongs to (GET /api/v2/users/current).

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 Capsule CRM connector tile, then select the credential that will be used to connect to your Capsule account, and click Next; or, create a new Capsule CRM 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 Capsule CRM 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.

List templates fetch every page: Nexla requests 100 records per page (50 for List Entries for Record) and follows the rel="next" URL in the Link header that Capsule returns until there are no more pages. Capsule calls projects kases in its API, so Record Type settings use parties, opportunities, or kases. Templates that read one record by ID need that ID, which you can get from the matching list or search template.

People and organisations​

List Deleted Parties

List people and organisations deleted (or made inaccessible) since a date.

  • Enter the Since. ISO 8601 date-time, e.g. 2026-01-01T00:00:00Z. Required by Capsule.
  • Capsule API reference

List Employees

List the people (employees) linked to one organisation, all pages.

  • Enter the Party ID. Capsule id of the party. Use the List Parties or Search Parties source template to find it.
  • Capsule API reference

List Parties

List all people and organisations of the account, all pages.

Get Parties by IDs

Get up to 10 people or organisations by a comma-separated list of ids.

  • Enter the Party IDs. Comma-separated party ids (at most 10). Use the List Parties or Search Parties source template to find it.
  • Capsule API reference

Get Party

Get one person or organisation by id.

  • Enter the Party ID. Capsule id of the party. Use the List Parties or Search Parties source template to find it.
  • Capsule API reference

Search Parties

Search people and organisations like Capsule's global search, all pages.

Opportunities, pipelines and goals​

List Deleted Opportunities

List opportunities deleted (or made inaccessible) since a date.

  • Enter the Since. ISO 8601 date-time, e.g. 2026-01-01T00:00:00Z. Required by Capsule.
  • Capsule API reference

List Goal Periods

List the periods of one goal with their progress, all pages.

  • Enter the Goal ID. Capsule id of the goal. Use the List Goals source template to find it.
  • Capsule API reference

List Goals

List the sales goals, all pages.

List Lost Reasons

List the opportunity lost reasons of the account.

List Milestones

List the milestones of the oldest active pipeline (legacy; see List Pipeline Milestones), all pages.

List Opportunities

List all opportunities of the account, all pages.

List Opportunity Additional Parties

List the additional people and organisations on one opportunity, all pages.

  • Enter the Opportunity ID. Capsule id of the opportunity. Use the List Opportunities source template to find it.
  • Capsule API reference

List Opportunity Projects

List the projects linked to one opportunity, all pages.

  • Enter the Opportunity ID. Capsule id of the opportunity. Use the List Opportunities source template to find it.
  • Capsule API reference

List Party Opportunities

List the opportunities of one person or organisation, all pages.

  • Enter the Party ID. Capsule id of the party. Use the List Parties or Search Parties source template to find it.
  • Capsule API reference

List Pipeline Milestones

List the milestones of one sales pipeline, all pages.

  • Enter the Pipeline ID. Capsule id of the pipeline. Use the List Pipelines source template to find it.
  • Capsule API reference

List Pipelines

List the sales pipelines of the account, all pages.

Get Goal

Get one sales goal by id.

  • Enter the Goal ID. Capsule id of the goal. Use the List Goals source template to find it.
  • Capsule API reference

Get Lost Reason

Get one opportunity lost reason by id.

  • Enter the Lost Reason ID. Capsule id of the lost reason. Use the List Lost Reasons source template to find it.
  • Capsule API reference

Get Milestone

Get one opportunity milestone by id.

  • Enter the Milestone ID. Capsule id of the milestone. Use the List Pipeline Milestones source template to find it.
  • Capsule API reference

Get Opportunities by IDs

Get up to 10 opportunities by a comma-separated list of ids.

  • Enter the Opportunity IDs. Comma-separated opportunity ids (at most 10). Use the List Opportunities source template to find it.
  • Capsule API reference

Get Opportunity

Get one opportunity by id.

  • Enter the Opportunity ID. Capsule id of the opportunity. Use the List Opportunities source template to find it.
  • Capsule API reference

Get Pipeline

Get one sales pipeline by id.

  • Enter the Pipeline ID. Capsule id of the pipeline. Use the List Pipelines source template to find it.
  • Capsule API reference

Get Pipelines by IDs

Get several sales pipelines by a comma-separated list of ids.

  • Enter the Pipeline IDs. Comma-separated pipeline ids. Use the List Pipelines source template to find it.
  • Capsule API reference

Search Opportunities

Search opportunities like Capsule's global search, all pages.

Projects and boards​

List Board Stages

List the active stages of one project board, all pages.

  • Enter the Board ID. Capsule id of the board. Use the List Boards source template to find it.
  • Capsule API reference

List Boards

List the active project boards of the account, all pages.

List Deleted Projects

List projects deleted (or made inaccessible) since a date.

  • Enter the Since. ISO 8601 date-time, e.g. 2026-01-01T00:00:00Z. Required by Capsule.
  • Capsule API reference

List Party Projects

List the projects of one person or organisation, all pages.

  • Enter the Party ID. Capsule id of the party. Use the List Parties or Search Parties source template to find it.
  • Capsule API reference

List Project Additional Parties

List the additional people and organisations on one project, all pages.

  • Enter the Project ID. Capsule id of the project. Use the List Projects source template to find it.
  • Capsule API reference

List Projects

List all projects (kases) of the account, all pages.

List Stages

List the active project board stages of the account, all pages.

Get Board

Get one project board by id.

  • Enter the Board ID. Capsule id of the board. Use the List Boards source template to find it.
  • Capsule API reference

Get Project

Get one project (kase) by id.

  • Enter the Project ID. Capsule id of the project. Use the List Projects source template to find it.
  • Capsule API reference

Get Projects by IDs

Get up to 10 projects by a comma-separated list of ids.

  • Enter the Project IDs. Comma-separated project ids (at most 10). Use the List Projects source template to find it.
  • Capsule API reference

Get Stage

Get one project board stage by id.

  • Enter the Stage ID. Capsule id of the stage. Use the List Stages source template to find it.
  • Capsule API reference

Search Projects

Search projects like Capsule's global search, all pages.

Tasks, tracks and history​

List Activity Type Icons

List the icons that can be set on an activity type.

List Activity Types

List the activity types (Call, Meeting, Email, ...) used on entries and tasks, all pages.

List Entries by Date

List notes, emails and completed party tasks across the account, newest first, all pages.

List Entries for Record

List the notes, emails and completed tasks of one party, opportunity or project, all pages.

  • Select the Record Type: parties, opportunities, kases (projects are kases in the Capsule API). Default: parties.
  • Enter the Record ID. Id of the party, opportunity or project.
  • Capsule API reference

List Task Categories

List the task categories of the account, all pages.

List Tasks

List the open tasks of the account (Capsule's default), all pages.

List Track Definitions

List the track definitions (task templates), all pages.

List Tracks for Record

List the tracks (task sequences) applied to one party, opportunity or project, all pages.

  • Select the Record Type: parties, opportunities, kases (projects are kases in the Capsule API). Default: parties.
  • Enter the Record ID. Id of the party, opportunity or project.
  • Capsule API reference

Get Activity Type

Get one activity type (e.g. Call, Meeting) by id.

  • Enter the Activity Type ID. Capsule id of the activity type. Use the List Activity Types source template to find it.
  • Capsule API reference

Get Entry

Get one note, email or completed task entry by id.

  • Enter the Entry ID. Capsule id of the entry. Use the List Entries by Date or List Entries for Record source template to find it.
  • Capsule API reference

Get Task

Get one task by id.

  • Enter the Task ID. Capsule id of the task. Use the List Tasks source template to find it.
  • Capsule API reference

Get Task Category

Get one task category by id.

  • Enter the Category ID. Capsule id of the category. Use the List Task Categories source template to find it.
  • Capsule API reference

Get Track

Get one track by id.

  • Enter the Track ID. Capsule id of the track. Use the List Tracks for Record source template to find it.
  • Capsule API reference

Get Track Definition

Get one track definition with its task definitions.

  • Enter the Track Definition ID. Capsule id of the track definition. Use the List Track Definitions source template to find it.
  • Capsule API reference

Tags and custom fields​

List Custom Fields

List the custom field definitions of parties, opportunities or projects, all pages.

  • Select the Record Type: parties, opportunities, kases (projects are kases in the Capsule API). Default: parties.
  • Capsule API reference

List Person Titles

List the person titles (Mr, Ms, custom titles) of the account.

List Tag Definitions

List the tag definitions of parties, opportunities or projects, all pages.

  • Select the Record Type: parties, opportunities, kases (projects are kases in the Capsule API). Default: parties.
  • Capsule API reference

Get Custom Field

Get one custom field definition of parties, opportunities or projects.

  • Select the Record Type: parties, opportunities, kases (projects are kases in the Capsule API). Default: parties.
  • Enter the Field ID. Capsule id of the field. Use the List Custom Fields source template to find it.
  • Capsule API reference

Get Tag Definition

Get one party, opportunity or project tag definition by id.

  • Select the Record Type: parties, opportunities, kases (projects are kases in the Capsule API). Default: parties.
  • Enter the Tag ID. Capsule id of the tag. Use the List Tag Definitions source template to find it.
  • Capsule API reference

Account, users and reference data​

Get Site

Get the Capsule site (account) name, subdomain and URL of the API token.

List Countries

List the country names Capsule accepts in party addresses (same for every account).

List Currencies

List the ISO currency codes Capsule accepts for opportunity values.

List REST Hooks

List the REST hooks (webhook subscriptions) on the account.

List Teams

List the teams on the account.

List Users

List the users of the Capsule account.

Get Current User

Get the Capsule user the API token belongs to.

Get Team

Get one team by id.

  • Enter the Team ID. Capsule id of the team. Use the List Teams source template to find it.
  • Capsule API reference

Get User

Get one Capsule user by id.

  • Enter the User ID. Capsule id of the user. Use the List Users source template to find it.
  • Capsule API reference

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​

Capsule CRM data sources can also be manually configured to ingest data from any valid Capsule API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters such as the since filter on parties, opportunities, and projects. 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. See the Capsule API v2 reference for the available endpoints.

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 Capsule CRM 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 Capsule CRM destination, and select the Send to Destination option from the menu. Select the Capsule CRM connector from the list of available destination connectors, then select the credential that will be used to connect to your Capsule account, and click Next; or, create a new Capsule CRM 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 Capsule CRM 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.

Each record in the Nexset is sent as the JSON body of one request, one record at a time. Capsule expects the record to be wrapped in the object's name, for example {"party": {"type": "organisation", "name": "Acme"}} for Create Party; each template below shows the expected shape. ID settings, such as Party ID or Opportunity ID, are fixed on the destination and apply to every record it sends, so update and delete templates act on the same Capsule record for every record in the Nexset. Templates marked Side effect change or remove data in ways that can't be undone from Nexla.

Capsule has no separate endpoint for tagging a record. To add a tag, include "tags": [{"name": "..."}] in an Update Party, Update Opportunity, or Update Project record; to remove one, include {"id": ..., "_delete": true} in the same list.

People and organisations​

Create Party

Create a person or organisation from each record: {"party": {"type": "person"|"organisation", ...}}. Tags, custom fields and tracks can be set in the same body.

Update Party

Update a person or organisation with each record ({"party": {...}}); omitted fields stay unchanged. Add tags with tags:[{name}], remove with {id, _delete: true}.

  • Enter the Party ID. Capsule id of the party. Use the List Parties or Search Parties source template to find it.
  • Capsule API reference

Delete Party

Side effect: Permanently deletes the person or organisation from Capsule (may be scheduled: HTTP 202).

  • Enter the Party ID. Capsule id of the party. Use the List Parties or Search Parties source template to find it.
  • Capsule API reference

Opportunities, pipelines and goals​

Add Party to Opportunity

Add a person or organisation as an additional contact on an opportunity (ids in the URL; no body needed).

  • Enter the Opportunity ID. Capsule id of the opportunity. Use the List Opportunities source template to find it.
  • Enter the Party ID. Capsule id of the party. Use the List Parties or Search Parties source template to find it.
  • Capsule API reference

Create Goal

Create a sales goal from each record: {"goal": {"name", "type", "frequency", "value", "startOn", "user", ...}}.

Create Lost Reason

Create an opportunity lost reason from each record: {"lostReason": {"name", "includedForConversion"}}. Administrator role.

Create Milestone

Create an opportunity milestone from each record: {"milestone": {"name", "probability", ...}}.

Create Opportunity

Create an opportunity from each record: {"opportunity": {"name", "party": {id}, "milestone": {id}, ...}}. Tags and custom fields can be set in the same body.

Create Pipeline

Create a sales pipeline from each record: {"pipeline": {"name", "description"}}.

Duplicate Pipeline

Copy a sales pipeline and its milestones (id in the URL; no body needed). Administrator role.

  • Enter the Pipeline ID. Capsule id of the pipeline. Use the List Pipelines source template to find it.
  • Capsule API reference

Restore Pipeline

Restore an archived sales pipeline (id in the URL; no body needed). Administrator role.

  • Enter the Pipeline ID. Capsule id of the pipeline. Use the List Pipelines source template to find it.
  • Capsule API reference

Update Goal

Update a sales goal with each record ({"goal": {...}}); assignee, type, pipeline and milestone cannot change.

  • Enter the Goal ID. Capsule id of the goal. Use the List Goals source template to find it.
  • Capsule API reference

Update Lost Reason

Update a lost reason with each record ({"lostReason": {...}}). Administrator role.

  • Enter the Lost Reason ID. Capsule id of the lost reason. Use the List Lost Reasons source template to find it.
  • Capsule API reference

Update Milestone

Update a milestone's name, description or probability with each record.

  • Enter the Milestone ID. Capsule id of the milestone. Use the List Pipeline Milestones source template to find it.
  • Capsule API reference

Update Opportunity

Update an opportunity with each record ({"opportunity": {...}}); omitted fields stay unchanged. Add tags with tags:[{name}], remove with {id, _delete: true}.

  • Enter the Opportunity ID. Capsule id of the opportunity. Use the List Opportunities source template to find it.
  • Capsule API reference

Update Pipeline

Update a sales pipeline with each record ({"pipeline": {...}}).

  • Enter the Pipeline ID. Capsule id of the pipeline. Use the List Pipelines source template to find it.
  • Capsule API reference

Archive Pipeline

Side effect: Archives the sales pipeline (restore with Restore Pipeline). Administrator role.

  • Enter the Pipeline ID. Capsule id of the pipeline. Use the List Pipelines source template to find it.
  • Capsule API reference

Delete Goal

Side effect: Permanently deletes the sales goal.

  • Enter the Goal ID. Capsule id of the goal. Use the List Goals source template to find it.
  • Capsule API reference

Delete Lost Reason

Side effect: Marks the lost reason deleted; it can no longer be chosen on opportunities. Administrator role.

  • Enter the Lost Reason ID. Capsule id of the lost reason. Use the List Lost Reasons source template to find it.
  • Capsule API reference

Delete Milestone

Side effect: Permanently deletes the milestone (fails while an opportunity uses it).

  • Enter the Milestone ID. Capsule id of the milestone. Use the List Pipeline Milestones source template to find it.
  • Capsule API reference

Delete Opportunity

Side effect: Permanently deletes the opportunity from Capsule.

  • Enter the Opportunity ID. Capsule id of the opportunity. Use the List Opportunities source template to find it.
  • Capsule API reference

Remove Party from Opportunity

Side effect: Removes the person or organisation as an additional contact of the opportunity.

  • Enter the Opportunity ID. Capsule id of the opportunity. Use the List Opportunities source template to find it.
  • Enter the Party ID. Capsule id of the party. Use the List Parties or Search Parties source template to find it.
  • Capsule API reference

Projects and boards​

Add Party to Project

Add a person or organisation as an additional contact on a project (ids in the URL; no body needed).

  • Enter the Project ID. Capsule id of the project. Use the List Projects source template to find it.
  • Enter the Party ID. Capsule id of the party. Use the List Parties or Search Parties source template to find it.
  • Capsule API reference

Create Board

Create a project board from each record: {"board": {"name", "description"}}. Administrator role; at most 30 active boards.

Create Project

Create a project from each record: {"kase": {"name", "party": {id}, ...}}. Tags, custom fields and tracks can be set in the same body.

Create Stage

Create a board stage from each record: {"stage": {"name", "board", "displayOrder"}}. Administrator role.

Restore Board

Restore an archived project board (id in the URL; no body needed). Administrator role.

  • Enter the Board ID. Capsule id of the board. Use the List Boards source template to find it.
  • Capsule API reference

Update Board

Update a project board with each record ({"board": {...}}). Administrator role.

  • Enter the Board ID. Capsule id of the board. Use the List Boards source template to find it.
  • Capsule API reference

Update Project

Update a project with each record ({"kase": {...}}); omitted fields stay unchanged. Add tags with tags:[{name}], remove with {id, _delete: true}.

  • Enter the Project ID. Capsule id of the project. Use the List Projects source template to find it.
  • Capsule API reference

Update Stage

Update a stage's name, description or position with each record ({"stage": {...}}).

  • Enter the Stage ID. Capsule id of the stage. Use the List Stages source template to find it.
  • Capsule API reference

Archive Board

Side effect: Archives the project board (restore with Restore Board). Administrator role.

  • Enter the Board ID. Capsule id of the board. Use the List Boards source template to find it.
  • Capsule API reference

Delete Project

Side effect: Permanently deletes the project from Capsule.

  • Enter the Project ID. Capsule id of the project. Use the List Projects source template to find it.
  • Capsule API reference

Delete Stage

Side effect: Permanently deletes the stage (fails while an open project uses it).

  • Enter the Stage ID. Capsule id of the stage. Use the List Stages source template to find it.
  • Capsule API reference

Remove Party from Project

Side effect: Removes the person or organisation as an additional contact of the project.

  • Enter the Project ID. Capsule id of the project. Use the List Projects source template to find it.
  • Enter the Party ID. Capsule id of the party. Use the List Parties or Search Parties source template to find it.
  • Capsule API reference

Tasks, tracks and history​

Create Activity Type

Create an activity type from each record: {"activityType": {"name", "icon": {id}}}. Teams edition accounts only.

Create Note

Add a note from each record: {"entry": {"type": "note", "content", and exactly one of party|opportunity|kase: {id}}}. Notes are the only entry type the API creates.

Create Task

Create a task from each record: {"task": {"description", "dueOn", "party"|"opportunity"|"kase": {id}, "owner": {id}}}.

Create Task Category

Create a task category from each record: {"category": {"name", "colour"}}.

Create Track

Side effect: Applies a track definition to a party, opportunity or project and creates its tasks. Record: {"track": {"definition", "party"|"opportunity"|"kase", ...}}.

Create Track Definition

Create a track definition (task template) from each record: {"trackDefinition": {"description", "captureRule", "direction", "taskDefinitions": [...]}}.

Update Activity Type

Update an activity type with each record ({"activityType": {...}}).

  • Enter the Activity Type ID. Capsule id of the activity type. Use the List Activity Types source template to find it.
  • Capsule API reference

Update Note or Email

Update the content of a note or email entry with each record ({"entry": {...}}).

  • Enter the Entry ID. Capsule id of the entry. Use the List Entries by Date or List Entries for Record source template to find it.
  • Capsule API reference

Update Task

Update a task with each record ({"task": {...}}); omitted fields stay unchanged.

  • Enter the Task ID. Capsule id of the task. Use the List Tasks source template to find it.
  • Capsule API reference

Update Task Category

Rename or recolour a task category with each record ({"category": {...}}).

  • Enter the Category ID. Capsule id of the category. Use the List Task Categories source template to find it.
  • Capsule API reference

Update Track

Update a track's description or trackDateOn with each record ({"track": {...}}).

  • Enter the Track ID. Capsule id of the track. Use the List Tracks for Record source template to find it.
  • Capsule API reference

Update Track Definition

Update a track definition with each record ({"trackDefinition": {...}}).

  • Enter the Track Definition ID. Capsule id of the track definition. Use the List Track Definitions source template to find it.
  • Capsule API reference

Delete Activity Type

Side effect: Permanently deletes the activity type.

  • Enter the Activity Type ID. Capsule id of the activity type. Use the List Activity Types source template to find it.
  • Capsule API reference

Delete Entry

Side effect: Permanently deletes the note, email or task entry and its attachments.

  • Enter the Entry ID. Capsule id of the entry. Use the List Entries by Date or List Entries for Record source template to find it.
  • Capsule API reference

Delete Task

Side effect: Permanently deletes the task from Capsule.

  • Enter the Task ID. Capsule id of the task. Use the List Tasks source template to find it.
  • Capsule API reference

Delete Task Category

Side effect: Deletes the task category; its tasks are kept but become uncategorized.

  • Enter the Category ID. Capsule id of the category. Use the List Task Categories source template to find it.
  • Capsule API reference

Delete Track

Side effect: Removes the track and its related tasks from the party, opportunity or project.

  • Enter the Track ID. Capsule id of the track. Use the List Tracks for Record source template to find it.
  • Capsule API reference

Delete Track Definition

Side effect: Permanently deletes the track definition.

  • Enter the Track Definition ID. Capsule id of the track definition. Use the List Track Definitions source template to find it.
  • Capsule API reference

Tags and custom fields​

Create Custom Field

Create a party, opportunity or project custom field from each record: {"definition": {"name", "type", ...}}.

  • Select the Record Type: parties, opportunities, kases (projects are kases in the Capsule API). Default: parties.
  • Capsule API reference

Create Person Title

Create a custom person title from each record: {"personTitle": {"title"}}. Administrator role; at most 50.

Create Tag Definition

Define a new party, opportunity or project tag from each record: {"tag": {"name", "dataTag": false}}. To tag a record, use Update Party/Opportunity/Project.

  • Select the Record Type: parties, opportunities, kases (projects are kases in the Capsule API). Default: parties.
  • Capsule API reference

Update Custom Field

Update a custom field definition with each record ({"definition": {...}}).

  • Select the Record Type: parties, opportunities, kases (projects are kases in the Capsule API). Default: parties.
  • Enter the Field ID. Capsule id of the field. Use the List Custom Fields source template to find it.
  • Capsule API reference

Update Tag Definition

Rename or change a party, opportunity or project tag with each record ({"tag": {...}}).

  • Select the Record Type: parties, opportunities, kases (projects are kases in the Capsule API). Default: parties.
  • Enter the Tag ID. Capsule id of the tag. Use the List Tag Definitions source template to find it.
  • Capsule API reference

Delete Custom Field

Side effect: Removes the custom field and its value from every party, opportunity and project (may be scheduled: HTTP 202).

  • Select the Record Type: parties, opportunities, kases (projects are kases in the Capsule API). Default: parties.
  • Enter the Field ID. Capsule id of the field. Use the List Custom Fields source template to find it.
  • Capsule API reference

Delete Person Title

Side effect: Deletes the custom person title (only if no party uses it). Administrator role.

  • Enter the Title ID. Capsule id of the title. Use the List Person Titles source template to find it.
  • Capsule API reference

Delete Tag Definition

Side effect: Removes the tag definition and untags every party, opportunity and project that had it.

  • Select the Record Type: parties, opportunities, kases (projects are kases in the Capsule API). Default: parties.
  • Enter the Tag ID. Capsule id of the tag. Use the List Tag Definitions source template to find it.
  • Capsule API reference

Account, users and reference data​

Update User

Update a Capsule user's preferences with each record ({"user": {...}}). Needs a token with the user_preference scope.

  • Enter the User ID. Capsule id of the user. Use the List Users source template to find it.
  • Capsule API reference

Manual configuration​

Capsule CRM destinations can also be manually configured to send data to any valid Capsule 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. See Capsule's Writing to the API guide for request formats.

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 Capsule CRM endpoint, open the destination resource menu, and select Activate.

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