Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /capsulecrm | Type: Application | PCID required: Yes
capsulecrm_create_entry
Create a new entry
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
entry | object | Yes | — | The entry value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entry": {
"type": "object",
"description": "The entry value",
"properties": {
"type": {
"type": "string",
"description": "Entry type, currently only 'note' is supported for creation."
},
"content": {
"type": "string",
"description": "The entry content text."
},
"party": {
"type": "object",
"description": "The party value"
},
"opportunity": {
"type": "object",
"description": "The opportunity value"
},
"kase": {
"type": "object",
"description": "The kase value"
},
"activityType": {
"type": "object",
"description": "Activity Type"
}
}
}
},
"required": [
"PCID",
"entry"
]
}
capsulecrm_create_opportunity
Create a new opportunity
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
embed | string | No | — | Comma-separated list of additional data to include. |
opportunity | object | Yes | — | The opportunity value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
},
"opportunity": {
"type": "object",
"description": "The opportunity value",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"description": {
"type": "string",
"description": "The description value"
},
"party": {
"type": "object",
"description": "The party value"
},
"milestone": {
"type": "object",
"description": "The milestone value"
},
"value": {
"type": "object",
"description": "The value value"
},
"expectedCloseOn": {
"type": "string",
"description": "Expected Close On"
},
"probability": {
"type": "integer",
"description": "The probability value"
},
"durationBasis": {
"type": "string",
"description": "Duration Basis"
},
"owner": {
"type": "object",
"description": "The owner value"
},
"tags": {
"type": "array",
"description": "The tags value"
},
"fields": {
"type": "array",
"description": "The fields value"
}
}
}
},
"required": [
"PCID",
"opportunity"
]
}
capsulecrm_create_party
Create a new party
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
embed | string | No | — | Comma-separated list of additional data to include. |
party | object | Yes | — | The party value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
},
"party": {
"type": "object",
"description": "The party value",
"properties": {
"type": {
"type": "string",
"description": "Type of party: person or organisation."
},
"title": {
"type": "string",
"description": "The title value"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"jobTitle": {
"type": "string",
"description": "Job Title"
},
"about": {
"type": "string",
"description": "The about value"
},
"organisation": {
"type": "object",
"description": "The organisation value"
},
"owner": {
"type": "object",
"description": "The owner value"
},
"emailAddresses": {
"type": "array",
"description": "Email Addresses"
},
"phoneNumbers": {
"type": "array",
"description": "Phone Numbers"
},
"addresses": {
"type": "array",
"description": "The addresses value"
},
"websites": {
"type": "array",
"description": "The websites value"
},
"tags": {
"type": "array",
"description": "The tags value"
},
"fields": {
"type": "array",
"description": "The fields value"
}
}
}
},
"required": [
"PCID",
"party"
]
}
capsulecrm_create_project
Create a new project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
embed | string | No | — | Comma-separated list of additional data to include. |
kase | object | Yes | — | The kase value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
},
"kase": {
"type": "object",
"description": "The kase value",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"description": {
"type": "string",
"description": "The description value"
},
"status": {
"type": "string",
"description": "The status value"
},
"party": {
"type": "object",
"description": "The party value"
},
"opportunity": {
"type": "object",
"description": "The opportunity value"
},
"expectedCloseOn": {
"type": "string",
"description": "Expected Close On"
},
"owner": {
"type": "object",
"description": "The owner value"
},
"tags": {
"type": "array",
"description": "The tags value"
},
"fields": {
"type": "array",
"description": "The fields value"
}
}
}
},
"required": [
"PCID",
"kase"
]
}
capsulecrm_create_task
Create a new task
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
embed | string | No | — | Comma-separated list of additional data to include. |
task | object | Yes | — | The task value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
},
"task": {
"type": "object",
"description": "The task value",
"properties": {
"description": {
"type": "string",
"description": "The task description (required for creation)."
},
"detail": {
"type": "string",
"description": "The detail value"
},
"dueOn": {
"type": "string",
"description": "Due date in YYYY-MM-DD format."
},
"dueTime": {
"type": "string",
"description": "Due time in HH:MM:SS format."
},
"party": {
"type": "object",
"description": "The party value"
},
"opportunity": {
"type": "object",
"description": "The opportunity value"
},
"kase": {
"type": "object",
"description": "The kase value"
},
"owner": {
"type": "object",
"description": "The owner value"
},
"category": {
"type": "object",
"description": "The category value"
}
}
}
},
"required": [
"PCID",
"task"
]
}
capsulecrm_delete_entry
Delete an entry
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
entryId | integer | Yes | — | The entry identifier. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entryId": {
"type": "integer",
"description": "The entry identifier."
}
},
"required": [
"PCID",
"entryId"
]
}
capsulecrm_delete_opportunity
Delete an opportunity
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
opportunityId | integer | Yes | — | The opportunity identifier. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"opportunityId": {
"type": "integer",
"description": "The opportunity identifier."
}
},
"required": [
"PCID",
"opportunityId"
]
}
capsulecrm_delete_party
Delete a party
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
partyId | integer | Yes | — | The party identifier. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"partyId": {
"type": "integer",
"description": "The party identifier."
}
},
"required": [
"PCID",
"partyId"
]
}
capsulecrm_delete_project
Delete a project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
projectId | integer | Yes | — | The project identifier. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The project identifier."
}
},
"required": [
"PCID",
"projectId"
]
}
capsulecrm_delete_task
Delete a task
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
taskId | integer | Yes | — | The task identifier. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The task identifier."
}
},
"required": [
"PCID",
"taskId"
]
}
capsulecrm_get_current_user
Show current user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
embed | string | No | — | Comma-separated list of additional data to include: party. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include: party."
}
},
"required": [
"PCID"
]
}
capsulecrm_get_entry
Show an entry
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
entryId | integer | Yes | — | The entry identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entryId": {
"type": "integer",
"description": "The entry identifier."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"entryId"
]
}
capsulecrm_get_opportunity
Show an opportunity
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
opportunityId | integer | Yes | — | The opportunity identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"opportunityId": {
"type": "integer",
"description": "The opportunity identifier."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"opportunityId"
]
}
capsulecrm_get_party
Show a party
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
partyId | integer | Yes | — | The party identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"partyId": {
"type": "integer",
"description": "The party identifier."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"partyId"
]
}
capsulecrm_get_project
Show a project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
projectId | integer | Yes | — | The project identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The project identifier."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"projectId"
]
}
capsulecrm_get_task
Show a task
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
taskId | integer | Yes | — | The task identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The task identifier."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"taskId"
]
}
capsulecrm_get_user
Show a user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
userId | integer | Yes | — | The user identifier. |
embed | string | No | — | Comma-separated list of additional data to include: party. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "integer",
"description": "The user identifier."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include: party."
}
},
"required": [
"PCID",
"userId"
]
}
capsulecrm_list_entries
List all entries
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include: party, kase, opportunity, creator, activityType. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include: party, kase, opportunity, creator, activityType."
}
},
"required": [
"PCID"
]
}
capsulecrm_list_opportunities
List all opportunities
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
since | string | No | — | ISO8601 date to filter entities modified after this date. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include: tags, fields, party, milestone, missingImportantFields. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"since": {
"type": "string",
"description": "ISO8601 date to filter entities modified after this date."
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include: tags, fields, party, milestone, missingImportantFields."
}
},
"required": [
"PCID"
]
}
capsulecrm_list_opportunity_entries
List entries for an opportunity
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
opportunityId | integer | Yes | — | The opportunity identifier. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-50 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"opportunityId": {
"type": "integer",
"description": "The opportunity identifier."
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-50 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"opportunityId"
]
}
List opportunity tag definitions
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
}
},
"required": [
"PCID"
]
}
capsulecrm_list_parties
List all parties (contacts)
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
since | string | No | — | ISO8601 date to filter entities modified after this date. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include: tags, fields, organisation, missingImportantFields. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"since": {
"type": "string",
"description": "ISO8601 date to filter entities modified after this date."
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include: tags, fields, organisation, missingImportantFields."
}
},
"required": [
"PCID"
]
}
capsulecrm_list_party_employees
List employees of an organisation
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
partyId | integer | Yes | — | The organisation identifier. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"partyId": {
"type": "integer",
"description": "The organisation identifier."
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"partyId"
]
}
capsulecrm_list_party_entries
List entries for a party
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
partyId | integer | Yes | — | The party identifier. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-50 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"partyId": {
"type": "integer",
"description": "The party identifier."
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-50 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"partyId"
]
}
capsulecrm_list_party_opportunities
List opportunities for a party
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
partyId | integer | Yes | — | The party identifier. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"partyId": {
"type": "integer",
"description": "The party identifier."
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"partyId"
]
}
capsulecrm_list_party_projects
List projects for a party
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
partyId | integer | Yes | — | The party identifier. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"partyId": {
"type": "integer",
"description": "The party identifier."
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"partyId"
]
}
List party tag definitions
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
}
},
"required": [
"PCID"
]
}
capsulecrm_list_project_entries
List entries for a project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
projectId | integer | Yes | — | The project identifier. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-50 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The project identifier."
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-50 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"projectId"
]
}
List project tag definitions
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
}
},
"required": [
"PCID"
]
}
capsulecrm_list_projects
List all projects
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
since | string | No | — | ISO8601 date to filter entities modified after this date. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include: tags, fields, party, opportunity, missingImportantFields. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"since": {
"type": "string",
"description": "ISO8601 date to filter entities modified after this date."
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include: tags, fields, party, opportunity, missingImportantFields."
}
},
"required": [
"PCID"
]
}
capsulecrm_list_tasks
List all tasks
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include: party, opportunity, kase, owner, nextTask. |
status | string | No | — | Filter by status: open, completed, pending (comma-separated). |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include: party, opportunity, kase, owner, nextTask."
},
"status": {
"type": "string",
"description": "Filter by status: open, completed, pending (comma-separated)."
}
},
"required": [
"PCID"
]
}
capsulecrm_list_users
List all users
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
embed | string | No | — | Comma-separated list of additional data to include: party. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include: party."
}
},
"required": [
"PCID"
]
}
capsulecrm_search_opportunities
Search opportunities
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
q | string | Yes | — | Search term. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q": {
"type": "string",
"description": "Search term."
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"q"
]
}
capsulecrm_search_parties
Search parties
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
q | string | Yes | — | Search term. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q": {
"type": "string",
"description": "Search term."
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"q"
]
}
capsulecrm_search_projects
Search projects
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
q | string | Yes | — | Search term. |
page | integer | No | — | Page number (default 1). |
perPage | integer | No | — | Results per page, 1-100 (default 50). |
embed | string | No | — | Comma-separated list of additional data to include. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"q": {
"type": "string",
"description": "Search term."
},
"page": {
"type": "integer",
"description": "Page number (default 1)."
},
"perPage": {
"type": "integer",
"description": "Results per page, 1-100 (default 50)."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
}
},
"required": [
"PCID",
"q"
]
}
capsulecrm_update_entry
Update an entry
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
entryId | integer | Yes | — | The entry identifier. |
entry | object | Yes | — | The entry value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entryId": {
"type": "integer",
"description": "The entry identifier."
},
"entry": {
"type": "object",
"description": "The entry value",
"properties": {
"type": {
"type": "string",
"description": "Entry type, currently only 'note' is supported for creation."
},
"content": {
"type": "string",
"description": "The entry content text."
},
"party": {
"type": "object",
"description": "The party value"
},
"opportunity": {
"type": "object",
"description": "The opportunity value"
},
"kase": {
"type": "object",
"description": "The kase value"
},
"activityType": {
"type": "object",
"description": "Activity Type"
}
}
}
},
"required": [
"PCID",
"entryId",
"entry"
]
}
capsulecrm_update_opportunity
Update an opportunity
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
opportunityId | integer | Yes | — | The opportunity identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
opportunity | object | Yes | — | The opportunity value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"opportunityId": {
"type": "integer",
"description": "The opportunity identifier."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
},
"opportunity": {
"type": "object",
"description": "The opportunity value",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"description": {
"type": "string",
"description": "The description value"
},
"party": {
"type": "object",
"description": "The party value"
},
"milestone": {
"type": "object",
"description": "The milestone value"
},
"value": {
"type": "object",
"description": "The value value"
},
"expectedCloseOn": {
"type": "string",
"description": "Expected Close On"
},
"probability": {
"type": "integer",
"description": "The probability value"
},
"durationBasis": {
"type": "string",
"description": "Duration Basis"
},
"owner": {
"type": "object",
"description": "The owner value"
},
"tags": {
"type": "array",
"description": "The tags value"
},
"fields": {
"type": "array",
"description": "The fields value"
}
}
}
},
"required": [
"PCID",
"opportunityId",
"opportunity"
]
}
capsulecrm_update_party
Update a party
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
partyId | integer | Yes | — | The party identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
party | object | Yes | — | The party value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"partyId": {
"type": "integer",
"description": "The party identifier."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
},
"party": {
"type": "object",
"description": "The party value",
"properties": {
"type": {
"type": "string",
"description": "Type of party: person or organisation."
},
"title": {
"type": "string",
"description": "The title value"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"jobTitle": {
"type": "string",
"description": "Job Title"
},
"about": {
"type": "string",
"description": "The about value"
},
"organisation": {
"type": "object",
"description": "The organisation value"
},
"owner": {
"type": "object",
"description": "The owner value"
},
"emailAddresses": {
"type": "array",
"description": "Email Addresses"
},
"phoneNumbers": {
"type": "array",
"description": "Phone Numbers"
},
"addresses": {
"type": "array",
"description": "The addresses value"
},
"websites": {
"type": "array",
"description": "The websites value"
},
"tags": {
"type": "array",
"description": "The tags value"
},
"fields": {
"type": "array",
"description": "The fields value"
}
}
}
},
"required": [
"PCID",
"partyId",
"party"
]
}
capsulecrm_update_project
Update a project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
projectId | integer | Yes | — | The project identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
kase | object | Yes | — | The kase value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectId": {
"type": "integer",
"description": "The project identifier."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
},
"kase": {
"type": "object",
"description": "The kase value",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"description": {
"type": "string",
"description": "The description value"
},
"status": {
"type": "string",
"description": "The status value"
},
"party": {
"type": "object",
"description": "The party value"
},
"opportunity": {
"type": "object",
"description": "The opportunity value"
},
"expectedCloseOn": {
"type": "string",
"description": "Expected Close On"
},
"owner": {
"type": "object",
"description": "The owner value"
},
"tags": {
"type": "array",
"description": "The tags value"
},
"fields": {
"type": "array",
"description": "The fields value"
}
}
}
},
"required": [
"PCID",
"projectId",
"kase"
]
}
capsulecrm_update_task
Update a task
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
taskId | integer | Yes | — | The task identifier. |
embed | string | No | — | Comma-separated list of additional data to include. |
task | object | Yes | — | The task value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The task identifier."
},
"embed": {
"type": "string",
"description": "Comma-separated list of additional data to include."
},
"task": {
"type": "object",
"description": "The task value",
"properties": {
"description": {
"type": "string",
"description": "The task description (required for creation)."
},
"detail": {
"type": "string",
"description": "The detail value"
},
"dueOn": {
"type": "string",
"description": "Due date in YYYY-MM-DD format."
},
"dueTime": {
"type": "string",
"description": "Due time in HH:MM:SS format."
},
"party": {
"type": "object",
"description": "The party value"
},
"opportunity": {
"type": "object",
"description": "The opportunity value"
},
"kase": {
"type": "object",
"description": "The kase value"
},
"owner": {
"type": "object",
"description": "The owner value"
},
"category": {
"type": "object",
"description": "The category value"
}
}
}
},
"required": [
"PCID",
"taskId",
"task"
]
}