Overview
Configuration is provided for establishing connections with Capsule CRM service. The configuration is used in the REST Connection Manager.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from the service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Capsule CRM REST API using COZYROC's REST Connection Manager.
Congratulations! You have now established a connection to your Capsule CRM instance.
In this guide, we will show how to read data from the Capsule CRM service resource using the COZYROC REST Source component.
In this guide, we will show how to write data to the Capsule CRM service resource using the COZYROC REST Destination component.
Configuration
Base URL address: https://api.capsulecrm.com/api/v2
.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}
.The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.capsulecrm.com/v2/overview/authentication#oauth-2.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/parties
.
The result is extracted from:{{=response.parties}}
.The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Party#listParties.
-
embed:
- [Read Single] action
-
Endpoint URL address:
/parties/{{=parameters.partyId}}
.
The result is extracted from:{{=[response.party]}}
.The action has the following user-defined parameters:
- partyId: Required. Specify party identifier.
The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Party#showParty.
- [Read Multiple] action
-
Endpoint URL address:
/parties/{{=parameters.partyIds}}
.
The result is extracted from:{{=utils.ensureArray(response.parties || response.party)}}
.The action has the following user-defined parameters:
- partyIds: Required. Specify parties identifiers in comma separated format .
The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Party#showMultipleParties.
- [Read Deleted] action
-
Endpoint URL address:
/parties/deleted
.
The result is extracted from:{{=response.parties}}
.The action has the following user-defined parameters:
- since: Required. Specify the since date.
The following request parameters will be automatically processed:
-
embed:
fields,tags
-
since:
{{=parameters.since}}
Documentation: https://developer.capsulecrm.com/v2/operations/Party#listDeletedParties.
- [Read Search] action
-
Endpoint URL address:
/parties/search
.
The result is extracted from:{{=response.parties}}
.The action has the following user-defined parameters:
- q: Required. Specify value to be search.
The following request parameters will be automatically processed:
-
embed:
fields,tags
-
q:
{{=parameters.q}}
Documentation: https://developer.capsulecrm.com/v2/operations/Party#searchParties.
- [Read Opportunity] action
-
Endpoint URL address:
/opportunities/{{=parameters.opportunityId}}/parties
.
The result is extracted from:{{=utils.ensureArray(response.parties || response.party)}}
.The action has the following user-defined parameters:
- opportunityId: Required. Specify opportunity identifier.
The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Opportunity#listParties.
- [Read Case] action
-
Endpoint URL address:
/kases/{{=parameters.caseId}}/parties
.
The result is extracted from:{{=utils.ensureArray(response.parties || response.party)}}
.The action has the following user-defined parameters:
- caseId: Required. Specify case identifier.
The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Case#listParties.
- [Read Filter] action
-
Endpoint URL address:
/parties/filters/results
.
The result is extracted from:{{=response.parties}}
.
The action uses POST method.The action has the following user-defined parameters:
- Query: Required. Specify in JSON format to specify the search criteria.
The following request parameters will be automatically processed:
-
embed:
fields,tags
-
application/json:
{{=JSON.parse(parameters.Query)}}
Documentation: https://developer.capsulecrm.com/v2/operations/Filter.
- [Create] action
-
Endpoint URL address:
/parties
.The following request parameters will be automatically processed:
-
application/json:
{{={ party : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Party#createParty.
-
application/json:
- [Update] action
-
Endpoint URL address:
/parties/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ party : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Party#updateParty.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/parties/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Party#deleteParty.
The resource includes the fields from the partyT template.
- employees
The value is gathered from
/parties/{{=item.id}}/people
address. The gathered value is processed with{{=response.parties}}
expression. Field components:- An array.
-
Uses template:
partyT
.
- opportunities
The value is gathered from
/parties/{{=item.id}}/opportunities
address. The gathered value is processed with{{=utils.ensureArray(response.opportunities || response.opportunity)}}
expression. Field components:- An array.
-
Uses template:
opportunityT
.
- Kases
The value is gathered from
/parties/{{=item.id}}/kases
address. The gathered value is processed with{{=utils.ensureArray(response.kases || response.kase)}}
expression. Field components:- An array.
-
Uses template:
opportunityT
.
- [External]
-
The external fields URL address:
/parties/fields/definitions
. The external fields list is extracted from:{{=response.definitions}}
.- custom.{{=external.name}}
Template: {{=Capsule.getFieldTemplate(external.type)}}. Before setting, the value is processed with
{{=Capsule.getFieldValue(field, value)}}
expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/opportunities
.
The result is extracted from:{{=response.opportunities}}
.The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Opportunity#listOpportunities.
-
embed:
- [Read Single] action
-
Endpoint URL address:
/opportunities/{{=parameters.opportunityId}}
.
The result is extracted from:{{=[response.opportunity]}}
.The action has the following user-defined parameters:
- opportunityId: Required. Specify opportunity identifier.
The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Opportunity#showOpportunity.
- [Read Multiple] action
-
Endpoint URL address:
/opportunities/{{=parameters.opportunityIds}}
.
The result is extracted from:{{=utils.ensureArray(response.opportunities || response.opportunity)}}
.The action has the following user-defined parameters:
- opportunityIds: Required. Specify opportunities identifiers in comma separated format.
The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Opportunity#showMultipleOpportunities.
- [Read Deleted] action
-
Endpoint URL address:
/opportunities/deleted
.
The result is extracted from:{{=response.opportunities}}
.The action has the following user-defined parameters:
- since: Required. Specify the since date.
The following request parameters will be automatically processed:
-
embed:
fields,tags
-
since:
{{=parameters.since}}
Documentation: https://developer.capsulecrm.com/v2/operations/Opportunity#listDeletedOpportunities.
- [Read Search] action
-
Endpoint URL address:
/opportunities/search
.
The result is extracted from:{{=response.opportunities}}
.The action has the following user-defined parameters:
- q: Required. Specify value to be search.
The following request parameters will be automatically processed:
-
embed:
fields,tags
-
q:
{{=parameters.q}}
Documentation: https://developer.capsulecrm.com/v2/operations/Opportunity#searchOpportunities.
- [Read Party] action
-
Endpoint URL address:
/parties/{{=parameters.partyId}}/opportunities
.
The result is extracted from:{{=response.opportunities}}
.The action has the following user-defined parameters:
- partyId: Required. Specify party identifier.
The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Opportunity#listOpportunitiesByParty.
- [Read Filter] action
-
Endpoint URL address:
/opportunities/filters/results
.
The result is extracted from:{{=response.opportunities}}
.
The action uses POST method.The action has the following user-defined parameters:
- Query: Required. Specify in JSON format to specify the search criteria.
The following request parameters will be automatically processed:
-
embed:
fields,tags
-
application/json:
{{=JSON.parse(parameters.Query)}}
Documentation: https://developer.capsulecrm.com/v2/operations/Filter.
- [Create] action
-
Endpoint URL address:
/opportunities
.The following request parameters will be automatically processed:
-
application/json:
{{={ opportunity : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Opportunity#createOpportunity.
-
application/json:
- [Update] action
-
Endpoint URL address:
/opportunities/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ opportunity : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Opportunity#updateOpportunity.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/opportunities/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Opportunity#deleteOpportunity.
The resource includes the fields from the opportunityT template.
- parties
The value is gathered from
/opportunities/{{=item.id}}/parties
address. The gathered value is processed with{{=utils.ensureArray(response.parties || response.party)}}
expression. Field components:- An array.
-
Uses template:
partyT
.
- cases
The value is gathered from
/opportunities/{{=item.id}}/kases
address. The gathered value is processed with{{=utils.ensureArray(response.kases || response.kase)}}
expression. Field components:- An array.
-
Uses template:
opportunityT
.
- [External]
-
The external fields URL address:
/opportunities/fields/definitions
. The external fields list is extracted from:{{=response.definitions}}
.- custom.{{=external.name}}
Template: {{=Capsule.getFieldTemplate(external.type)}}. Before setting, the value is processed with
{{=Capsule.getFieldValue(field, value)}}
expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/kases
.
The result is extracted from:{{=response.kases}}
.The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Case#listCases.
-
embed:
- [Read Single] action
-
Endpoint URL address:
/kases/{{=parameters.kaseId}}
.
The result is extracted from:{{=[response.kase]}}
.The action has the following user-defined parameters:
- kaseId: Required. Specify kase identifier.
The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Case#showCase.
- [Read Multiple] action
-
Endpoint URL address:
/opportunities/{{=parameters.opportunityIds}}
.
The result is extracted from:{{=utils.ensureArray(response.kases || response.kase)}}
.The action has the following user-defined parameters:
- kaseIds: Required. Specify kases identifiers in comma separated format .
The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Case#showMultipleCases.
- [Read Deleted] action
-
Endpoint URL address:
/kases/deleted
.
The result is extracted from:{{=response.kases}}
.The action has the following user-defined parameters:
- since: Required. Specify the since date.
The following request parameters will be automatically processed:
-
embed:
fields,tags
-
since:
{{=parameters.since}}
Documentation: https://developer.capsulecrm.com/v2/operations/Case#listDeletedCases.
- [Read Search] action
-
Endpoint URL address:
/kases/search
.
The result is extracted from:{{=response.kases}}
.The action has the following user-defined parameters:
- q: Required. Specify value to be search.
The following request parameters will be automatically processed:
-
embed:
fields,tags
-
q:
{{=parameters.q}}
Documentation: https://developer.capsulecrm.com/v2/operations/Case#searchCases.
- [Read Party] action
-
Endpoint URL address:
/parties/{{=parameters.partyId}}/kases
.
The result is extracted from:{{=utils.ensureArray(response.kases || response.kase)}}
.The action has the following user-defined parameters:
- partyId: Required. Specify party identifier.
The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Case#listCasesByParty.
- [Read Opportunity] action
-
Endpoint URL address:
/opportunities/{{=parameters.opportunityId}}/kases
.
The result is extracted from:{{=utils.ensureArray(response.kases || response.kase)}}
.The action has the following user-defined parameters:
- opportunityId: Required. Specify opportunity identifier.
The following request parameters will be automatically processed:
-
embed:
fields,tags
Documentation: https://developer.capsulecrm.com/v2/operations/Opportunity#listCases.
- [Read Filter] action
-
Endpoint URL address:
/kases/filters/results
.
The result is extracted from:{{=response.kases}}
.
The action uses POST method.The action has the following user-defined parameters:
- Query: Required. Specify in JSON format to specify the search criteria.
The following request parameters will be automatically processed:
-
embed:
fields,tags
-
application/json:
{{=JSON.parse(parameters.Query)}}
Documentation: https://developer.capsulecrm.com/v2/operations/Filter.
- [Create] action
-
Endpoint URL address:
/kases
.The following request parameters will be automatically processed:
-
application/json:
{{={ kase : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Case#createCase.
-
application/json:
- [Update] action
-
Endpoint URL address:
/kases/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ kase : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Case#updateCase.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/kases/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Case#deleteCase.
The resource includes the fields from the opportunityT template.
- parties
The value is gathered from
/kases/{{=item.id}}/parties
address. The gathered value is processed with{{=utils.ensureArray(response.parties || response.party)}}
expression. Field components:- An array.
-
Uses template:
partyT
.
- [External]
-
The external fields URL address:
/kases/fields/definitions
. The external fields list is extracted from:{{=response.definitions}}
.- custom.{{=external.name}}
Template: {{=Capsule.getFieldTemplate(external.type)}}. Before setting, the value is processed with
{{=Capsule.getFieldValue(field, value)}}
expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tasks
.
The result is extracted from:{{=response.tasks}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Task#listTasks.
- [Read Single] action
-
Endpoint URL address:
/tasks/{{=parameters.taskId}}
.
The result is extracted from:{{=[response.kase]}}
.The action has the following user-defined parameters:
- taskId: Required. Specify task identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Task#showTask.
- [Create] action
-
Endpoint URL address:
/tasks
.The following request parameters will be automatically processed:
-
application/json:
{{={ task : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Task#createTask.
-
application/json:
- [Update] action
-
Endpoint URL address:
/tasks/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ task : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Task#updateTask.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/tasks/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Task#deleteTask.
- id
A key field. Data type: DT_I4
- category
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, colour.
-
Uses template:
- description
Template: ShortText.
- status
Template: ShortText.
- party
Template: oppPartyT.
- owner
Template: ownerT.
- kase
Template: kaseT.
- opportunity
Template: oppPartyT.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- dueOn
Template: Date.
- dueTime
Data type: DT_DBTIME
- hasTrack
Data type: DT_BOOL
- repeat
Field components:
-
Uses template:
ShortText
. - Contains the following components: interval, frequency, on.
-
Uses template:
- nextTask
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, description.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entity}}/{{=parameters.entityId}}/tracks
.
The result is extracted from:{{=response.tracks}}
.The action has the following user-defined parameters:
- entity: Required. Must opportunities or kases.
- entityId: Required. Specify entity identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Track#listTrack.
- [Read Single] action
-
Endpoint URL address:
/tracks/{{=parameters.trackId}}
.
The result is extracted from:{{=[response.track]}}
.The action has the following user-defined parameters:
- trackId: Required. Specify track identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Track#showTrack.
- [Create] action
-
Endpoint URL address:
/tracks
.The following request parameters will be automatically processed:
-
application/json:
{{={ track : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Track#createTrack.
-
application/json:
- [Update] action
-
Endpoint URL address:
/tracks/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ task : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Track#updateTrack.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/tracks/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Track#deleteTrack.
- id
A key field. Data type: DT_I4
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- description
Template: ShortText.
- captureRule
Template: ShortText.
- kase
Template: opportunityT.
- definition
Data type: DT_I4
- direction
Template: ShortText.
- trackDateOn
Data type: DT_DBTIME
- opportunity
Template: opportunityT.
- tasks
Field components:
- An array.
- Contains the following components: id, description.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/trackdefinitions
.
The result is extracted from:{{=response.trackDefinitions}}
.
- id
Data type: DT_I4
- description
Template: ShortText.
- daysAfterRule
Template: ShortText.
- daysAfter
Data type: DT_I4
- displayOrder
Data type: DT_I4
- createdAt
Template: DateTime.
- updatedAt
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/site
.
The result is extracted from:{{=[response.site]}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Site#show.
- url
Template: ShortText.
- subdomain
Template: ShortText.
- name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users
.
The result is extracted from:{{=response.users}}
.Documentation: https://developer.capsulecrm.com/v2/operations/User#listUsers.
- [Read Single] action
-
Endpoint URL address:
/users/{{=parameters.userId}}
.
The result is extracted from:{{=[response.user]}}
.The action has the following user-defined parameters:
- userId: Required. Specify user identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/User#showUser.
- [Read Current] action
-
Endpoint URL address:
/users/current
.
The result is extracted from:{{=[response.user]}}
.Documentation: https://developer.capsulecrm.com/v2/operations/User#showCurrentUser.
- [Update] action
-
Endpoint URL address:
/users/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ user : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/User#updateUser.
-
application/json:
- id
A key field. Data type: DT_I4
- locale
Template: ShortText.
- currency
Template: ShortText.
- status
Template: ShortText.
- emailPreference
Template: ShortText.
- clickToCallPreference
Template: ShortText.
- preferredEmailFromAddress
Template: ShortText.
- tags
Template: tagsT.
- organisation
Template: organisationT.
- fields
Template: fieldsT.
- party
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, type, firstName, lastName, pictureURL.
-
Uses template:
- username
Template: ShortText.
- timezone
Template: ShortText.
- lastLoginAt
Template: DateTime. A read-only field.
- name
Template: ShortText.
- taskReminder
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/teams
.
The result is extracted from:{{=response.teams}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Team#listTeams.
- [Read Single] action
-
Endpoint URL address:
/teams/{{=parameters.teamId}}
.
The result is extracted from:{{=[response.team]}}
.The action has the following user-defined parameters:
- teamId: Required. Specify team identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Team#showTeam.
- id
A key field. Data type: DT_I4
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- name
Template: ShortText.
- tags
Template: tagsT.
- organisation
Template: organisationT.
- fields
Template: fieldsT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entity}}/tags
.
The result is extracted from:{{=response.tags}}
.The action has the following user-defined parameters:
- entity: Required. Specify entity. Must be Kases, parties or either opportunities
Documentation: https://developer.capsulecrm.com/v2/operations/Tag#listTags.
- [Read Single] action
-
Endpoint URL address:
/{{=parameters.entity}}/tags/{{=parameters.tagId}}
.
The result is extracted from:{{=response.tag}}
.The action has the following user-defined parameters:
- entity: Required. Specify entity. Must be Kases, parties or either opportunities
- tagId: Required. Specify tag identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Tag#showTag.
- [Create] action
-
Endpoint URL address:
/{{=parameters.entity}}/tags
.The action has the following user-defined parameters:
- entity: Required. Specify entity. Must be Kases, parties or either opportunities
The following request parameters will be automatically processed:
-
application/json:
{{={ tag : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Tag#createTag.
- [Update] action
-
Endpoint URL address:
/{{=parameters.entity}}/tags/{{=item.id}}
.The action has the following user-defined parameters:
- entity: Required. Specify entity. Must be Kases, parties or either opportunities
The following request parameters will be automatically processed:
-
application/json:
{{={ tag : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/User#updateUser.
- [Delete] action
-
Endpoint URL address:
/{{=parameters.entity}}/tags/{{=item.id}}
.The action has the following user-defined parameters:
- entity: Required. Specify entity. Must be Kases, parties or either opportunities
Documentation: https://developer.capsulecrm.com/v2/operations/Tag#deleteTag.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- description
Template: ShortText.
- dataTag
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entity}}/fields/definitions
.
The result is extracted from:{{=response.definitions}}
.The action has the following user-defined parameters:
- entity: Required. Specify entity. Must be Kases, parties or either opportunities
Documentation: https://developer.capsulecrm.com/v2/operations/Custom_Field#listFields.
- [Read Single] action
-
Endpoint URL address:
/{{=parameters.entity}}/fields/definitions/{{=parameters.fieldId}}
.
The result is extracted from:{{=[response.definition]}}
.The action has the following user-defined parameters:
- entity: Required. Specify entity. Must be Kases, parties or either opportunities
- fieldId: Required. Specify field identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Custom_Field#showField.
- [Create] action
-
Endpoint URL address:
/{{=parameters.entity}}/fields/definitions
.The action has the following user-defined parameters:
- entity: Required. Specify entity. Must be Kases, parties or either opportunities
The following request parameters will be automatically processed:
-
application/json:
{{={ definition : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Custom_Field#createField.
- [Update] action
-
Endpoint URL address:
/{{=parameters.entity}}/fields/definitions/{{=item.id}}
.The action has the following user-defined parameters:
- entity: Required. Specify entity. Must be Kases, parties or either opportunities
The following request parameters will be automatically processed:
-
application/json:
{{={ definition : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Custom_Field#updateField.
- [Delete] action
-
Endpoint URL address:
/{{=parameters.entity}}/fields/definitions/{{=item.id}}
.The action has the following user-defined parameters:
- entity: Required. Specify entity. Must be Kases, parties or either opportunities
Documentation: https://developer.capsulecrm.com/v2/operations/Custom_Field#deleteField.
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- displayOrder
Data type: DT_I4
- name
Template: ShortText.
- description
Template: ShortText.
- captureRule
Template: ShortText.
- important
Data type: DT_BOOL
- tag
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, dataTag.
-
Uses template:
- options
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/titles
.
The result is extracted from:{{=response.personTitles}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Custom_Title#listTitles.
- [Create] action
-
Endpoint URL address:
/titles
.The following request parameters will be automatically processed:
-
application/json:
{{={ personTitle : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Custom_Title#createTitle.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/titles/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/User#updateUser.
- id
A key field. Data type: DT_I4
- title
Template: ShortText.
- systemTitle
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/countries
.
The result is extracted from:{{=response.countries}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Internationalization#listCountries.
- [Read Currencies] action
-
Endpoint URL address:
/countries
.
The result is extracted from:{{=response.currencies}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Internationalization#listCurrenciess.
- alpha2Code
Template: ShortText.
- alpha3Code
Template: ShortText.
- numericCode
Data type: DT_I4
- name
Template: ShortText.
- code
Template: ShortText.
- symbol
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/activitytypes
.
The result is extracted from:{{=response.activityTypes}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Activity_Type#listActivityTypes.
- [Read Single] action
-
Endpoint URL address:
/activitytypes/{{=parameters.activityTypeId}}
.
The result is extracted from:{{=[response.activityType]}}
.The action has the following user-defined parameters:
- activityTypeId: Required. Specify activity type identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Activity_Type#showActivityType.
- [Read Icon] action
-
Endpoint URL address:
/activitytypes/icons
.
The result is extracted from:{{=response.activityTypeIcons}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Activity_Type#listActivityTypeIcons.
- [Create] action
-
Endpoint URL address:
/activitytypes
.The following request parameters will be automatically processed:
-
application/json:
{{={ activityType : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Activity_Type#createActivityType.
-
application/json:
- [Update] action
-
Endpoint URL address:
/activitytypes/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ activityType : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Activity_Type#updateActivityType.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/activitytypes/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Activity_Type#deleteActivityType.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- displayName
Template: ShortText.
- iconName
Template: ShortText.
- order
Data type: DT_I4
- isSystem
Data type: DT_BOOL
- icon
Field components:
-
Uses template:
ShortText
. - Contains the following components: order, id, displayName, iconName, isSystem.
-
Uses template:
- updateLastContacted
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/categories
.
The result is extracted from:{{=response.categories}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Category#listCategories.
- [Read Single] action
-
Endpoint URL address:
/categories/{{=parameters.categoryId}}
.
The result is extracted from:{{=[response.category]}}
.The action has the following user-defined parameters:
- categoryId: Required. Specify task category identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Category#showCategory.
- [Create] action
-
Endpoint URL address:
/categories
.The following request parameters will be automatically processed:
-
application/json:
{{={ category : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Category#createCategory.
-
application/json:
- [Update] action
-
Endpoint URL address:
/categories/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ category : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Category#updateCategory.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/categories/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Category#deleteCategory.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- colour
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/resthooks
.
The result is extracted from:{{=response.restHooks}}
.Documentation: https://developer.capsulecrm.com/v2/operations/REST_Hook#listRestHooks.
- [Read Single] action
-
Endpoint URL address:
/resthooks/{{=parameters.restHookId}}
.
The result is extracted from:{{=[response.restHook]}}
.The action has the following user-defined parameters:
- restHookId: Required. Specify restHook identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/REST_Hook#showRestHook.
- [Create] action
-
Endpoint URL address:
/resthooks
.The following request parameters will be automatically processed:
-
application/json:
{{={ restHook : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/REST_Hook#subscribeRestHook.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/resthooks/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/REST_Hook#unsubscribeRestHook.
- id
Data type: DT_I4
- event
Template: ShortText.
- targetUrl
Template: ShortText.
- embed
Template: ShortText.
- batched
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lostreasons
.
The result is extracted from:{{=response.lostReasons}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Lost_Reason#listLostReasons.
- [Read Single] action
-
Endpoint URL address:
/lostreasons/{{=parameters.lostReasonId}}
.
The result is extracted from:{{=[response.lostReason]}}
.The action has the following user-defined parameters:
- lostReasonId: Required. Specify lostReason identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Lost_Reason#showLostReason.
- [Create] action
-
Endpoint URL address:
/lostreasons
.The following request parameters will be automatically processed:
-
application/json:
{{={ lostReason : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Lost_Reason#createLostReason.
-
application/json:
- [Update] action
-
Endpoint URL address:
/lostreasons/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ lostReason : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Lost_Reason#updateLostReason.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/lostreasons/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Lost_Reason#deleteLostReason.
- id
Data type: DT_I4
- name
Template: ShortText.
- includedForConversion
Data type: DT_BOOL
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/milestones
.
The result is extracted from:{{=response.milestones}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Milestone#listMilestones.
- [Read Single] action
-
Endpoint URL address:
/milestones/{{=parameters.milestoneId}}
.
The result is extracted from:{{=[response.milestone]}}
.The action has the following user-defined parameters:
- milestoneId: Required. Specify milestone identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Milestone#showMilestone.
- [Read Pipeline] action
-
Endpoint URL address:
/pipelines/{{=parameters.pipelineId}}/milestones
.
The result is extracted from:{{=response.milestones}}
.The action has the following user-defined parameters:
- pipelineId: Required. Specify pipeline identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Milestone#listMilestonesForPipeline.
- [Create] action
-
Endpoint URL address:
/milestones
.The following request parameters will be automatically processed:
-
application/json:
{{={ milestone : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Milestone#createMilestone.
-
application/json:
- [Update] action
-
Endpoint URL address:
/milestones/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ milestone : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Milestone#updateMilestone.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/milestones/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Milestone#deleteMilestone.
The resource includes the fields from the ResMilestoneT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/pipelines
.
The result is extracted from:{{=response.pipelines}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Milestone#listMilestonesForPipeline.
- [Read Single] action
-
Endpoint URL address:
/pipelines/{{=parameters.pipelineId}}
.
The result is extracted from:{{=[response.pipeline]}}
.The action has the following user-defined parameters:
- pipelineId: Required. Specify pipeline identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Pipeline#showPipeline.
- [Read Multiple] action
-
Endpoint URL address:
/pipelines/{{=parameters.pipelineIds}}
.
The result is extracted from:{{=utils.ensureArray(response.pipelines || response.pipeline)}}
.The action has the following user-defined parameters:
- pipelineIds: Required. Specify pipelineIds using comma separated format.
Documentation: https://developer.capsulecrm.com/v2/operations/Pipeline#showPipeline.
- [Create] action
-
Endpoint URL address:
/pipelines
.The following request parameters will be automatically processed:
-
application/json:
{{={ pipeline : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Pipeline#createPipeline.
-
application/json:
- [Update] action
-
Endpoint URL address:
/pipelines/{{=item.id}}
.The following request parameters will be automatically processed:
-
application/json:
{{={ pipeline : item } }}
Documentation: https://developer.capsulecrm.com/v2/operations/Pipeline#updatePipeline.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/pipelines/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Pipeline#archivePipeline.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- description
Template: ShortText.
- isDeleted
Data type: DT_BOOL
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- milestones
The value is gathered from
/pipelines/{{=item.id}}/milestones
address. The gathered value is processed with{{=response.milestones}}
expression. Field components:- An array.
-
Uses template:
ResMilestoneT
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.entity}}/{{=parameters.entityId}}/entries
.
The result is extracted from:{{=response.entries}}
.The action has the following user-defined parameters:
- entity: Required. Specify entityId. Must be one of the folowing(parties,opportunities or kases).
- entityId: Required. Specify entity identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Entry#listEntriesForEntity.
- [Read Single] action
-
Endpoint URL address:
/entries/{{=parameters.id}}
.
The result is extracted from:{{=[response.entry]}}
.The action has the following user-defined parameters:
- id: Required. Specify the identifier.
Documentation: https://developer.capsulecrm.com/v2/operations/Entry#showEntry.
- [Read Date] action
-
Endpoint URL address:
/entries
.
The result is extracted from:{{=response.entries}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Entry#listEntriesByDate.
- [Delete] action
-
Endpoint URL address:
/entries/{{=item.id}}
.Documentation: https://developer.capsulecrm.com/v2/operations/Entry#deleteEntry.
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- attachments
Field components:
- An array.
- Contains the following components: id, filename, contentType, size, content.
- creator
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, username, name.
-
Uses template:
- activityType
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name.
-
Uses template:
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- content
Template: ShortText.
- entryAt
Template: DateTime. A read-only field.
- party
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, type, name, pictureURL.
-
Uses template:
- kase
Template: kaseT.
- opportunity
Template: oppPartyT.
- parties
Template: oppPartyT.
- participants
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, adrress, name, role.
-
Uses template:
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}}
-
perPage:
{{=parameters.batchSize}}
-
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Boolean
Data type: DT_BOOL
- Number
Data type: DT_R8
- tagsT
Field components:
- An array.
- Contains the following components: id, name, dataTag.
- fieldsT
Field components:
- An array.
- Contains the following components: definition, id, tagId, value.
- websitesT
Field components:
- An array.
- Contains the following components: id, type, address, service, url.
- addressesT
Field components:
- An array.
- Contains the following components: id, type, city, country, street, state, zip.
- phoneNumbersT
Field components:
- An array.
- Contains the following components: id, type, number.
- emailAddressesT
Field components:
- An array.
- Contains the following components: id, type, address.
- ownerT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, username, name.
-
Uses template:
- teamT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name.
-
Uses template:
- organisationT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, type, name, pictureURL, isRestricted, firstName, lastName.
-
Uses template:
- partyT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, type, about, title, firstName, lastName, jobTitle, createdAt, updatedAt, organisation, lastContactedAt, tags, organisation, fields, addresses, phoneNumbers, websites, emailAddresses, pictureURL, owner, team, deletedAt, missingImportantFields.
-
Uses template:
- oppPartyT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, pictureURL, type, name, firstName, lastName, isRestricted.
-
Uses template:
- milestoneT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name.
-
Uses template:
- valueT
Field components:
-
Uses template:
ShortText
. - Contains the following components: amount, currency.
-
Uses template:
- opportunityT
Field components:
-
Uses template:
DateTime
. - Contains the following components: id, updatedAt, deletedAt, lastContactAt, description, owner, tags, organisation, fields, party, lostReason, lastOpenMilestone, team, value, milestone, value, expectedCloseOn, missingImportantFields, probability, durationBasis, duration, closedOn, createdAt, name, status, opportunity.
-
Uses template:
- kaseT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, type, isRestricted.
-
Uses template:
- ResMilestoneT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, name, description, complete, probability, daysUntilStale, createdAt, updatedAt.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.