/centralstationcrm-activities | Type: Application | PCID required: Yes
Tools
centralstationcrm_activities_delete_api_cal_events_by_cal_event_id_cal_event_attendees_by_id
Destroy a cal event attendee Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
cal_event_id | string | Yes | — | Cal Event Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"cal_event_id": {
"type": "string",
"description": "Cal Event Id"
}
},
"required": [
"PCID",
"id",
"cal_event_id"
]
}
centralstationcrm_activities_delete_api_cal_events_by_id
Destroy a cal event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
no_log | boolean | No | — | Set to true if you don’t want to generate a activity for the stream. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"no_log": {
"type": "boolean",
"description": "Set to true if you don't want to generate a activity for the stream."
}
},
"required": [
"PCID",
"id"
]
}
centralstationcrm_activities_delete_api_comments_by_id
Destroy a comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
centralstationcrm_activities_delete_api_protocols_by_id
Destroy a protocol Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
centralstationcrm_activities_delete_api_protocols_by_protocol_id_attachments_by_id
delete attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
protocol_id | integer | Yes | — | Protocol Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"protocol_id": {
"type": "integer",
"description": "Protocol Id"
}
},
"required": [
"PCID",
"id",
"protocol_id"
]
}
centralstationcrm_activities_delete_api_tasks_by_id
Destroy a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
centralstationcrm_activities_get_api_activities
Retrieves activities for the record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perpage | integer | No | — | Elements per page, maximum of 250 |
page | integer | No | — | Retrieve records of the given page |
order | string | No | — | Ordering of records using one of the following order options: occurred_at-asc, occurred_at-desc, id-asc, id-desc |
includes | string | No | — | possible includes are: user, activity_receivers separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: attachable, responsible_user_natural_name separated by space. Receive all methods using the ‘all’ value. |
filter | object | No | — | Optionally submit one of the activities attributes in order to filter by them (e.g. { ‘user_id’: { ‘equal’: ‘your-value’ } }). Allowed filter modifiers are smaller_than, larger_than, equal, between or in. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. { 'between': '2023-01-01,2023-02-01' }) and in allows a list of comma separated options (e.g. { 'in': '23,42,99' }). |
person_id | integer | No | — | ID of the desired person activities |
company_id | integer | No | — | Optional ID of the desired company activities |
deal_id | integer | No | — | Optional ID of the desired deal activities |
project_id | integer | No | — | Optional ID of the desired project activities |
user_id | integer | No | — | ID of the desired user activities |
account_id | integer | No | — | ID of the desired account activities |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"perpage": {
"type": "integer",
"description": "Elements per page, maximum of 250"
},
"page": {
"type": "integer",
"description": "Retrieve records of the given page"
},
"order": {
"type": "string",
"description": "Ordering of records using one of the following order options: `occurred_at-asc`, `occurred_at-desc`, `id-asc`, `id-desc`"
},
"includes": {
"type": "string",
"description": "possible includes are: user, activity_receivers separated by space. Receive all includes using the 'all' value."
},
"methods": {
"type": "string",
"description": "Possible methods are: attachable, responsible_user_natural_name separated by space. Receive all methods using the 'all' value."
},
"filter": {
"type": "object",
"description": "Optionally submit one of the activities attributes in order to filter by them (e.g. { 'user_id': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)."
},
"person_id": {
"type": "integer",
"description": "ID of the desired person activities"
},
"company_id": {
"type": "integer",
"description": "Optional ID of the desired company activities"
},
"deal_id": {
"type": "integer",
"description": "Optional ID of the desired deal activities"
},
"project_id": {
"type": "integer",
"description": "Optional ID of the desired project activities"
},
"user_id": {
"type": "integer",
"description": "ID of the desired user activities"
},
"account_id": {
"type": "integer",
"description": "ID of the desired account activities"
}
},
"required": [
"PCID"
]
}
centralstationcrm_activities_get_api_activities_by_id
retrieve activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
includes | string | No | — | possible includes are: user, activity_receivers separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: attachable, responsible_user_natural_name separated by space. Receive all methods using the ‘all’ value. |
filter | object | No | — | Optionally submit one of the activities attributes in order to filter by them (e.g. { ‘user_id’: { ‘equal’: ‘your-value’ } }). Allowed filter modifiers are smaller_than, larger_than, equal, between or in. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. { 'between': '2023-01-01,2023-02-01' }) and in allows a list of comma separated options (e.g. { 'in': '23,42,99' }). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"includes": {
"type": "string",
"description": "possible includes are: user, activity_receivers separated by space. Receive all includes using the 'all' value."
},
"methods": {
"type": "string",
"description": "Possible methods are: attachable, responsible_user_natural_name separated by space. Receive all methods using the 'all' value."
},
"filter": {
"type": "object",
"description": "Optionally submit one of the activities attributes in order to filter by them (e.g. { 'user_id': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)."
}
},
"required": [
"PCID",
"id"
]
}
centralstationcrm_activities_get_api_activities_count
Retrieves activities count for the record, account or user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perpage | integer | No | — | Elements per page, maximum of 250 |
page | integer | No | — | Retrieve records of the given page |
includes | string | No | — | possible includes are: user, activity_receivers separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: attachable, responsible_user_natural_name separated by space. Receive all methods using the ‘all’ value. |
person_id | integer | No | — | ID of the desired person activities |
company_id | integer | No | — | ID of the desired company activities |
deal_id | integer | No | — | ID of the desired deal activities |
project_id | integer | No | — | ID of the desired project activities |
account_id | integer | No | — | ID of the desired account activities |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"perpage": {
"type": "integer",
"description": "Elements per page, maximum of 250"
},
"page": {
"type": "integer",
"description": "Retrieve records of the given page"
},
"includes": {
"type": "string",
"description": "possible includes are: user, activity_receivers separated by space. Receive all includes using the 'all' value."
},
"methods": {
"type": "string",
"description": "Possible methods are: attachable, responsible_user_natural_name separated by space. Receive all methods using the 'all' value."
},
"person_id": {
"type": "integer",
"description": "ID of the desired person activities"
},
"company_id": {
"type": "integer",
"description": "ID of the desired company activities"
},
"deal_id": {
"type": "integer",
"description": "ID of the desired deal activities"
},
"project_id": {
"type": "integer",
"description": "ID of the desired project activities"
},
"account_id": {
"type": "integer",
"description": "ID of the desired account activities"
}
},
"required": [
"PCID"
]
}
centralstationcrm_activities_get_api_cal_events
Retrieves all cal events of the account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
order | string | No | — | Ordering of records using one of the following order options: id-asc, id-desc |
perpage | integer | No | — | Elements per page, maximum of 250 |
page | integer | No | — | Retrieve records of the given page |
includes | string | No | — | possible includes are: user, group_calendar, people, users, cal_event_attendees, comments separated by space. Receive all includes using the ‘all’ value. |
state | string | No | — | Optionally submit upcoming or old to return only those CalEvents |
before | string | No | — | Optionally submit a date formatted YYYY-MM-DD to return only CalEvents before this date |
after | string | No | — | Optionally submit a date formatted YYYY-MM-DD to return only CalEvents after this date |
filter | object | No | — | Optionally submit one of the calevents attributes in order to filter by them (e.g. { ‘user_id’: { ‘equal’: ‘your-value’ } }). Allowed filter modifiers are smaller_than, larger_than, equal, between or in. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. { 'between': '2023-01-01,2023-02-01' }) and in allows a list of comma separated options (e.g. { 'in': '23,42,99' }). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"order": {
"type": "string",
"description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`"
},
"perpage": {
"type": "integer",
"description": "Elements per page, maximum of 250"
},
"page": {
"type": "integer",
"description": "Retrieve records of the given page"
},
"includes": {
"type": "string",
"description": "possible includes are: user, group_calendar, people, users, cal_event_attendees, comments separated by space. Receive all includes using the 'all' value."
},
"state": {
"type": "string",
"description": "Optionally submit `upcoming` or `old` to return only those CalEvents"
},
"before": {
"type": "string",
"description": "Optionally submit a date formatted `YYYY-MM-DD` to return only CalEvents before this date"
},
"after": {
"type": "string",
"description": "Optionally submit a date formatted `YYYY-MM-DD` to return only CalEvents after this date"
},
"filter": {
"type": "object",
"description": "Optionally submit one of the calevents attributes in order to filter by them (e.g. { 'user_id': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)."
}
},
"required": [
"PCID"
]
}
centralstationcrm_activities_get_api_cal_events_by_cal_event_id_cal_event_attendees
Retrieves all cal event attendees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal_event_id | string | Yes | — | Cal Event Id |
includes | string | No | — | possible includes are: user, person, cal_event separated by space. Receive all includes using the ‘all’ value. |
order | string | No | — | Ordering of records using one of the following order options: id-asc, id-desc |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal_event_id": {
"type": "string",
"description": "Cal Event Id"
},
"includes": {
"type": "string",
"description": "possible includes are: user, person, cal_event separated by space. Receive all includes using the 'all' value."
},
"order": {
"type": "string",
"description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`"
}
},
"required": [
"PCID",
"cal_event_id"
]
}
centralstationcrm_activities_get_api_cal_events_by_cal_event_id_cal_event_attendees_by_id
Retrieves a cal event attendee Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
cal_event_id | string | Yes | — | Cal Event Id |
includes | string | No | — | possible includes are: user, person, cal_event separated by space. Receive all includes using the ‘all’ value. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"cal_event_id": {
"type": "string",
"description": "Cal Event Id"
},
"includes": {
"type": "string",
"description": "possible includes are: user, person, cal_event separated by space. Receive all includes using the 'all' value."
}
},
"required": [
"PCID",
"id",
"cal_event_id"
]
}
centralstationcrm_activities_get_api_cal_events_by_id
Retrieves a cal event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
includes | string | No | — | possible includes are: user, group_calendar, people, users, cal_event_attendees, comments separated by space. Receive all includes using the ‘all’ value. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"includes": {
"type": "string",
"description": "possible includes are: user, group_calendar, people, users, cal_event_attendees, comments separated by space. Receive all includes using the 'all' value."
}
},
"required": [
"PCID",
"id"
]
}
centralstationcrm_activities_get_api_comments
Retrieves all comments of the account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
order | string | No | — | Ordering of records using one of the following order options: id-asc, id-desc |
perpage | integer | No | — | Elements per page, maximum of 250 |
page | integer | No | — | Retrieve records of the given page |
methods | string | No | — | Possible option: responsible_user_natural_name |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"order": {
"type": "string",
"description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`"
},
"perpage": {
"type": "integer",
"description": "Elements per page, maximum of 250"
},
"page": {
"type": "integer",
"description": "Retrieve records of the given page"
},
"methods": {
"type": "string",
"description": "Possible option: responsible_user_natural_name"
}
},
"required": [
"PCID"
]
}
centralstationcrm_activities_get_api_comments_by_id
Retrieves a comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
methods | string | No | — | Possible option: responsible_user_natural_name |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"methods": {
"type": "string",
"description": "Possible option: responsible_user_natural_name"
}
},
"required": [
"PCID",
"id"
]
}
centralstationcrm_activities_get_api_historic_events
Retrieves all historic_events of the account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
order | string | No | — | Ordering of records using one of the following order options: id-asc, id-desc |
perpage | integer | No | — | Elements per page, maximum of 250 |
page | integer | No | — | Retrieve records of the given page |
filter | object | No | — | Optionally submit one of the historicevents attributes in order to filter by them (e.g. { ‘name’: { ‘equal’: ‘your-value’ } }). Allowed filter modifiers are smaller_than, larger_than, equal, between or in. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. { 'between': '2023-01-01,2023-02-01' }) and in allows a list of comma separated options (e.g. { 'in': '23,42,99' }). |
date_from | string | No | — | Optionally submit a date_from in order to filter the HistoricEvents after and before the submitted dates.Once you submit the date_from param, the date_to param is mandatory too. |
date_to | string | No | — | Optionally submit a date_to in order to filter the HistoricEvents after and before the submitted dates.Once you submit the date_to param, the date_from param is mandatory too. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"order": {
"type": "string",
"description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`"
},
"perpage": {
"type": "integer",
"description": "Elements per page, maximum of 250"
},
"page": {
"type": "integer",
"description": "Retrieve records of the given page"
},
"filter": {
"type": "object",
"description": "Optionally submit one of the historicevents attributes in order to filter by them (e.g. { 'name': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)."
},
"date_from": {
"type": "string",
"description": "Optionally submit a `date_from` in order to filter the HistoricEvents after and before the submitted dates.Once you submit the `date_from` param, the `date_to` param is mandatory too."
},
"date_to": {
"type": "string",
"description": "Optionally submit a `date_to` in order to filter the HistoricEvents after and before the submitted dates.Once you submit the `date_to` param, the `date_from` param is mandatory too."
}
},
"required": [
"PCID"
]
}
centralstationcrm_activities_get_api_protocols
Retrieves all protocols Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
order | string | No | — | Ordering of records using one of the following order options: id-asc, id-desc |
perpage | integer | No | — | Elements per page, maximum of 250 |
page | integer | No | — | Retrieve records of the given page |
methods | string | No | — | Possible methods are: responsible_user_natural_name, absolute_url, conversion_step_names separated by space. Receive all methods using the ‘all’ value. |
includes | string | No | — | possible option: comments |
person_id | integer | No | — | Optional ID of the desired person |
company_id | integer | No | — | Optional ID of the desired company protocols |
deal_id | integer | No | — | Optional ID of the desired deal protocols |
project_id | integer | No | — | Optional ID of the desired project protocols |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"order": {
"type": "string",
"description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`"
},
"perpage": {
"type": "integer",
"description": "Elements per page, maximum of 250"
},
"page": {
"type": "integer",
"description": "Retrieve records of the given page"
},
"methods": {
"type": "string",
"description": "Possible methods are: responsible_user_natural_name, absolute_url, conversion_step_names separated by space. Receive all methods using the 'all' value."
},
"includes": {
"type": "string",
"description": "possible option: comments"
},
"person_id": {
"type": "integer",
"description": "Optional ID of the desired person"
},
"company_id": {
"type": "integer",
"description": "Optional ID of the desired company protocols"
},
"deal_id": {
"type": "integer",
"description": "Optional ID of the desired deal protocols"
},
"project_id": {
"type": "integer",
"description": "Optional ID of the desired project protocols"
}
},
"required": [
"PCID"
]
}
centralstationcrm_activities_get_api_protocols_by_id
Retrieves a protocol Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
methods | string | No | — | Possible methods are: responsible_user_natural_name, absolute_url, conversion_step_names separated by space. Receive all methods using the ‘all’ value. |
includes | string | No | — | possible option: comments |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"methods": {
"type": "string",
"description": "Possible methods are: responsible_user_natural_name, absolute_url, conversion_step_names separated by space. Receive all methods using the 'all' value."
},
"includes": {
"type": "string",
"description": "possible option: comments"
}
},
"required": [
"PCID",
"id"
]
}
centralstationcrm_activities_get_api_protocols_by_protocol_id_attachments
Retrieves all attachments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includes | string | No | — | possible includes are: user, attachment_category, comments separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the ‘all’ value. |
order | string | No | — | Ordering of records using one of the following order options: id-asc, id-desc |
perpage | integer | No | — | Elements per page, maximum of 250 |
page | integer | No | — | Retrieve records of the given page |
protocol_id | integer | Yes | — | Protocol Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"includes": {
"type": "string",
"description": "possible includes are: user, attachment_category, comments separated by space. Receive all includes using the 'all' value."
},
"methods": {
"type": "string",
"description": "Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the 'all' value."
},
"order": {
"type": "string",
"description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`"
},
"perpage": {
"type": "integer",
"description": "Elements per page, maximum of 250"
},
"page": {
"type": "integer",
"description": "Retrieve records of the given page"
},
"protocol_id": {
"type": "integer",
"description": "Protocol Id"
}
},
"required": [
"PCID",
"protocol_id"
]
}
centralstationcrm_activities_get_api_protocols_by_protocol_id_attachments_by_id
retrieve attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
protocol_id | integer | Yes | — | Protocol Id |
includes | string | No | — | possible includes are: user, attachment_category, comments separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the ‘all’ value. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"protocol_id": {
"type": "integer",
"description": "Protocol Id"
},
"includes": {
"type": "string",
"description": "possible includes are: user, attachment_category, comments separated by space. Receive all includes using the 'all' value."
},
"methods": {
"type": "string",
"description": "Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the 'all' value."
}
},
"required": [
"PCID",
"id",
"protocol_id"
]
}
centralstationcrm_activities_get_api_protocols_count
Retrieves total amount of protocolsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
centralstationcrm_activities_get_api_tasks
Retrieves all tasks of the account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
order | string | No | — | Ordering of records using one of the following order options: id-asc, id-desc |
perpage | integer | No | — | Elements per page, maximum of 250 |
page | integer | No | — | Retrieve records of the given page |
includes | string | No | — | possible includes are: user, comments separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible option: responsible_user_natural_name |
state | string | No | — | Optionally submit open or closed to return only those tasks |
before | string | No | — | Optionally submit a date formatted YYYY-MM-DD to return only tasks before this date |
after | string | No | — | Optionally submit a date formatted YYYY-MM-DD to return only tasks after this date |
user_id | string | No | — | optional parameter to filter by a users ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"order": {
"type": "string",
"description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`"
},
"perpage": {
"type": "integer",
"description": "Elements per page, maximum of 250"
},
"page": {
"type": "integer",
"description": "Retrieve records of the given page"
},
"includes": {
"type": "string",
"description": "possible includes are: user, comments separated by space. Receive all includes using the 'all' value."
},
"methods": {
"type": "string",
"description": "Possible option: responsible_user_natural_name"
},
"state": {
"type": "string",
"description": "Optionally submit `open` or `closed` to return only those tasks"
},
"before": {
"type": "string",
"description": "Optionally submit a date formatted `YYYY-MM-DD` to return only tasks before this date"
},
"after": {
"type": "string",
"description": "Optionally submit a date formatted `YYYY-MM-DD` to return only tasks after this date"
},
"user_id": {
"type": "string",
"description": "optional parameter to filter by a users ID"
}
},
"required": [
"PCID"
]
}
centralstationcrm_activities_get_api_tasks_by_id
Retrieves a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
includes | string | No | — | possible includes are: user, comments separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible option: responsible_user_natural_name |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"includes": {
"type": "string",
"description": "possible includes are: user, comments separated by space. Receive all includes using the 'all' value."
},
"methods": {
"type": "string",
"description": "Possible option: responsible_user_natural_name"
}
},
"required": [
"PCID",
"id"
]
}
centralstationcrm_activities_post_api_cal_events
Creates a cal event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includes | string | No | — | possible includes are: user, group_calendar, people, users, cal_event_attendees, comments separated by space. Receive all includes using the ‘all’ value. |
no_log | boolean | No | — | Set to true if you don’t want to generate a activity for the stream. |
cal_event | object | No | — | Cal Event |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"includes": {
"type": "string",
"description": "possible includes are: user, group_calendar, people, users, cal_event_attendees, comments separated by space. Receive all includes using the 'all' value."
},
"no_log": {
"type": "boolean",
"description": "Set to true if you don't want to generate a activity for the stream."
},
"cal_event": {
"type": "object",
"description": "Cal Event",
"properties": {
"user_id": {
"type": "integer",
"description": "User Id"
},
"attachable_id": {
"type": "integer",
"description": "id of the record the cal event belongs to (e.g. a person)"
},
"attachable_type": {
"type": "string",
"description": "can be Person, Company, Deal, Company or Null"
},
"group_calendar_id": {
"type": "string",
"description": "Group Calendar Id"
},
"name": {
"type": "string",
"description": "The name value"
},
"location": {
"type": "string",
"description": "description of the location, can be an address, a Meeting room id or left blank"
},
"starts_at": {
"type": "string",
"description": "Starts At"
},
"ends_at": {
"type": "string",
"description": "Ends At"
},
"status": {
"type": "string",
"description": "can be new, confirmed, tentative or cancelled"
},
"all_day": {
"type": "boolean",
"description": "set to true for events that last the whole day (e.g. holidays)"
},
"email_invitations": {
"type": "boolean",
"description": "set to true and CSCRM will send out email invitations to all attendees"
},
"description": {
"type": "string",
"description": "details regarding the event, e.g. agenda"
}
},
"required": [
"user_id",
"group_calendar_id",
"name",
"starts_at",
"ends_at",
"status"
]
}
},
"required": [
"PCID"
]
}
centralstationcrm_activities_post_api_cal_events_by_cal_event_id_cal_event_attendees
Creates a cal event attendee Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal_event_id | string | Yes | — | Cal Event Id |
cal_event_attendee | object | No | — | Cal Event Attendee |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cal_event_id": {
"type": "string",
"description": "Cal Event Id"
},
"cal_event_attendee": {
"type": "object",
"description": "Cal Event Attendee",
"properties": {
"person_id": {
"type": "integer",
"description": "id of the related CSCRM person. Either person_id or user_id has to be set to valid records"
},
"user_id": {
"type": "integer",
"description": "id of the related CSCRM user. Either person_id or user_id has to be set to valid records"
},
"email": {
"type": "string",
"description": "email address of the attending person or user. Invitations will be sent to this address, if email_notifications is set to true for the related cal event"
},
"status": {
"type": "string",
"description": "can be new, invited, no_invite, accepted, rejected, perhaps or canceled"
}
},
"required": [
"cal_event_id",
"person_id",
"status"
]
}
},
"required": [
"PCID",
"cal_event_id"
]
}
centralstationcrm_activities_post_api_comments
Creates a comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
methods | string | No | — | Possible option: responsible_user_natural_name |
comment | object | No | — | The comment value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"methods": {
"type": "string",
"description": "Possible option: responsible_user_natural_name"
},
"comment": {
"type": "object",
"description": "The comment value",
"properties": {
"attachable_type": {
"type": "string",
"description": "Attachable Type",
"enum": [
"Attachment",
"CalEvent",
"Protocol",
"ExternalEmail",
"Task"
]
},
"attachable_id": {
"type": "string",
"description": "Attachable Id"
},
"user_id": {
"type": "integer",
"description": "User Id"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"name"
]
}
},
"required": [
"PCID"
]
}
centralstationcrm_activities_post_api_protocols
Creates a protocol Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
only_object_logging | boolean | No | — | Set to true if you want the new protocol only to show up on the object pages, not on the status stream. |
methods | string | No | — | Possible methods are: responsible_user_natural_name, absolute_url, conversion_step_names separated by space. Receive all methods using the ‘all’ value. |
includes | string | No | — | possible option: comments |
attachment | object | No | — | The attachment value |
protocol | object | No | — | The protocol value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"only_object_logging": {
"type": "boolean",
"description": "Set to true if you want the new protocol only to show up on the object pages, not on the status stream."
},
"methods": {
"type": "string",
"description": "Possible methods are: responsible_user_natural_name, absolute_url, conversion_step_names separated by space. Receive all methods using the 'all' value."
},
"includes": {
"type": "string",
"description": "possible option: comments"
},
"attachment": {
"description": "The attachment value"
},
"protocol": {
"description": "The protocol value"
}
},
"required": [
"PCID"
]
}
centralstationcrm_activities_post_api_protocols_by_protocol_id_attachments
create attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includes | string | No | — | possible includes are: user, attachment_category, comments separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the ‘all’ value. |
protocol_id | integer | Yes | — | Protocol Id |
attachment | object | No | — | The attachment value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"includes": {
"type": "string",
"description": "possible includes are: user, attachment_category, comments separated by space. Receive all includes using the 'all' value."
},
"methods": {
"type": "string",
"description": "Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the 'all' value."
},
"protocol_id": {
"type": "integer",
"description": "Protocol Id"
},
"attachment": {
"description": "The attachment value"
}
},
"required": [
"PCID",
"protocol_id"
]
}
centralstationcrm_activities_post_api_tasks
Creates a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includes | string | No | — | possible includes are: user, comments separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible option: responsible_user_natural_name |
task | object | No | — | The task value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"includes": {
"type": "string",
"description": "possible includes are: user, comments separated by space. Receive all includes using the 'all' value."
},
"methods": {
"type": "string",
"description": "Possible option: responsible_user_natural_name"
},
"task": {
"type": "object",
"description": "The task value",
"properties": {
"user_id": {
"type": "integer",
"description": "User Id"
},
"attachable_id": {
"type": "integer",
"description": "id of the record the task belongs to (e.g. a person)"
},
"attachable_type": {
"type": "string",
"description": "can be Person, Company, Deal, Company or Null"
},
"task_list_id": {
"type": "integer",
"description": "id of the task list the task belongs to (has to be within the attachable record)"
},
"badge": {
"type": "string",
"description": "can be task, call, email, visit, preparation or important. Default will be task"
},
"name": {
"type": "string",
"description": "The name value"
},
"precise_time": {
"type": "string",
"description": "Precise Time"
},
"finished": {
"type": "boolean",
"description": "set to true, if the task is done"
},
"fuzzy": {
"type": "boolean",
"description": "set to true, if the precise_time hour and minutes are irrelevant, but the task may be done at any time during the day"
}
},
"required": [
"user_id",
"name"
]
}
},
"required": [
"PCID"
]
}
centralstationcrm_activities_put_api_cal_events_by_cal_event_id_cal_event_attendees_by_id
Update a cal event attendee Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
cal_event_id | string | Yes | — | Cal Event Id |
cal_event_attendee | object | No | — | Cal Event Attendee |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"cal_event_id": {
"type": "string",
"description": "Cal Event Id"
},
"cal_event_attendee": {
"type": "object",
"description": "Cal Event Attendee",
"properties": {
"person_id": {
"type": "integer",
"description": "id of the related CSCRM person. Either person_id or user_id has to be set to valid records"
},
"user_id": {
"type": "integer",
"description": "id of the related CSCRM user. Either person_id or user_id has to be set to valid records"
},
"email": {
"type": "string",
"description": "email address of the attending person or user. Invitations will be sent to this address, if email_notifications is set to true for the related cal event"
},
"status": {
"type": "string",
"description": "can be new, invited, no_invite, accepted, rejected, perhaps or canceled"
}
},
"required": [
"cal_event_id",
"person_id",
"status"
]
}
},
"required": [
"PCID",
"id",
"cal_event_id"
]
}
centralstationcrm_activities_put_api_cal_events_by_id
Update a cal event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
no_log | boolean | No | — | Set to true if you don’t want to generate a activity for the stream. |
cal_event | object | No | — | Cal Event |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"no_log": {
"type": "boolean",
"description": "Set to true if you don't want to generate a activity for the stream."
},
"cal_event": {
"type": "object",
"description": "Cal Event",
"properties": {
"user_id": {
"type": "integer",
"description": "User Id"
},
"attachable_id": {
"type": "integer",
"description": "id of the record the cal event belongs to (e.g. a person)"
},
"attachable_type": {
"type": "string",
"description": "can be Person, Company, Deal, Company or Null"
},
"group_calendar_id": {
"type": "string",
"description": "Group Calendar Id"
},
"name": {
"type": "string",
"description": "The name value"
},
"location": {
"type": "string",
"description": "description of the location, can be an address, a Meeting room id or left blank"
},
"starts_at": {
"type": "string",
"description": "Starts At"
},
"ends_at": {
"type": "string",
"description": "Ends At"
},
"status": {
"type": "string",
"description": "can be new, confirmed, tentative or cancelled"
},
"all_day": {
"type": "boolean",
"description": "set to true for events that last the whole day (e.g. holidays)"
},
"email_invitations": {
"type": "boolean",
"description": "set to true and CSCRM will send out email invitations to all attendees"
},
"description": {
"type": "string",
"description": "details regarding the event, e.g. agenda"
}
},
"required": [
"user_id",
"group_calendar_id",
"name",
"starts_at",
"ends_at",
"status"
]
}
},
"required": [
"PCID",
"id"
]
}
centralstationcrm_activities_put_api_comments_by_id
Update a comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
comment | object | No | — | The comment value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"comment": {
"type": "object",
"description": "The comment value",
"properties": {
"attachable_type": {
"type": "string",
"description": "Attachable Type",
"enum": [
"Attachment",
"CalEvent",
"Protocol",
"ExternalEmail",
"Task"
]
},
"attachable_id": {
"type": "string",
"description": "Attachable Id"
},
"user_id": {
"type": "integer",
"description": "User Id"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"name"
]
}
},
"required": [
"PCID",
"id"
]
}
centralstationcrm_activities_put_api_protocols_by_id
Update a protocol Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
attachment | object | No | — | The attachment value |
protocol | object | No | — | The protocol value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"attachment": {
"description": "The attachment value"
},
"protocol": {
"description": "The protocol value"
}
},
"required": [
"PCID",
"id"
]
}
centralstationcrm_activities_put_api_tasks_by_id
Update a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
task | object | No | — | The task value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
},
"task": {
"type": "object",
"description": "The task value",
"properties": {
"user_id": {
"type": "integer",
"description": "User Id"
},
"attachable_id": {
"type": "integer",
"description": "id of the record the task belongs to (e.g. a person)"
},
"attachable_type": {
"type": "string",
"description": "can be Person, Company, Deal, Company or Null"
},
"task_list_id": {
"type": "integer",
"description": "id of the task list the task belongs to (has to be within the attachable record)"
},
"badge": {
"type": "string",
"description": "can be task, call, email, visit, preparation or important. Default will be task"
},
"name": {
"type": "string",
"description": "The name value"
},
"precise_time": {
"type": "string",
"description": "Precise Time"
},
"finished": {
"type": "boolean",
"description": "set to true, if the task is done"
},
"fuzzy": {
"type": "boolean",
"description": "set to true, if the precise_time hour and minutes are irrelevant, but the task may be done at any time during the day"
}
},
"required": [
"user_id",
"name"
]
}
},
"required": [
"PCID",
"id"
]
}

