/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 | — | id |
cal_event_id | string | Yes | — | cal_event_id |
centralstationcrm_activities_delete_api_cal_events_by_id
Destroy a cal event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
no_log | boolean | No | — | Set to true if you don’t want to generate a activity for the stream. |
centralstationcrm_activities_delete_api_comments_by_id
Destroy a comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
centralstationcrm_activities_delete_api_protocols_by_id
Destroy a protocol Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
centralstationcrm_activities_delete_api_protocols_by_protocol_id_attachments_by_id
delete attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
protocol_id | integer | Yes | — | protocol_id |
centralstationcrm_activities_delete_api_tasks_by_id
Destroy a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | 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 |
centralstationcrm_activities_get_api_activities_by_id
retrieve activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
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' }). |
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 |
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' }). |
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 |
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 | — | id |
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. |
centralstationcrm_activities_get_api_cal_events_by_id
Retrieves a cal event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
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. |
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 |
centralstationcrm_activities_get_api_comments_by_id
Retrieves a comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
methods | string | No | — | Possible option: responsible_user_natural_name |
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. |
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 |
centralstationcrm_activities_get_api_protocols_by_id
Retrieves a protocol Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
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 |
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 |
centralstationcrm_activities_get_api_protocols_by_protocol_id_attachments_by_id
retrieve attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
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. |
centralstationcrm_activities_get_api_protocols_count
Retrieves total amount of protocolscentralstationcrm_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 |
centralstationcrm_activities_get_api_tasks_by_id
Retrieves a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
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 |
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 |
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 |
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 | — | comment |
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 | — | attachment |
protocol | object | No | — | protocol |
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 | — | attachment |
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 | — | task |
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 | — | id |
cal_event_id | string | Yes | — | cal_event_id |
cal_event_attendee | object | No | — | cal_event_attendee |
centralstationcrm_activities_put_api_cal_events_by_id
Update a cal event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
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 |
centralstationcrm_activities_put_api_comments_by_id
Update a comment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
comment | object | No | — | comment |
centralstationcrm_activities_put_api_protocols_by_id
Update a protocol Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
attachment | object | No | — | attachment |
protocol | object | No | — | protocol |
centralstationcrm_activities_put_api_tasks_by_id
Update a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | id |
task | object | No | — | task |

