/centralstationcrm-deals-projects | Type: Application | PCID required: Yes
Tools
centralstationcrm_deals_projects_delete_api_deals_by_id
Destroy a deal 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_deals_projects_delete_api_projects_by_id
Destroy a project 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_deals_projects_get_api_deals
Retrieves all deals 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: date-asc, date-desc, new-asc, new-desc, update-asc, update-desc, value-asc, value-desc, state-asc, state-desc, abc-asc, abc-desc |
includes | string | No | — | possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value. |
tag_id | integer | No | — | Optionally submit a tag ID in order to only see deals tagged with the submitted tag |
tag_name | string | No | — | Optionally submit a tag name in order to only see deals tagged with the submitted tag |
stream_updated_at_before | string | No | — | Optionally submit a date or timestamp (ISO 8601) in order to only see deals with activities within the stream earlier than the submitted point in time. |
stream_updated_at_after | string | No | — | Optionally submit a date or timestamp (ISO 8601) in order to only see deals with activities within the stream later than the submitted point in time. |
filter | object | No | — | Optionally submit one of the deals 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_deals_projects_get_api_deals_by_deal_id_external_emails
Retrieves all external_emails 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 option: comments |
deal_id | integer | Yes | — | ID of the external_emails of the desired deal |
centralstationcrm_deals_projects_get_api_deals_by_deal_id_external_emails_count
Retrieves total amount of external_emails Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deal_id | integer | Yes | — | ID of the external_emails of the desired deal |
centralstationcrm_deals_projects_get_api_deals_by_deal_id_maildrop
Retrieves the maildrop Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
deal_id | integer | Yes | — | ID of the deal the maildrop belong to |
centralstationcrm_deals_projects_get_api_deals_by_id
Retrieves a deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | id |
includes | string | No | — | possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value. |
centralstationcrm_deals_projects_get_api_deals_count
Retrieves total amount of deals Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag_id | integer | No | — | Optionally submit a tag ID in order to only see deals tagged with the submitted tag |
tag_name | string | No | — | Optionally submit a tag name in order to only see deals tagged with the submitted tag |
filter | object | No | — | Optionally submit one of the deals 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_deals_projects_get_api_deals_search
Retrieves deals matching the search Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perpage | integer | No | — | Elements per page, maximum of 250 |
page | integer | No | — | Retrieve records of the given page |
name | string | No | — | Retrieve deals by their name |
includes | string | No | — | possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value. |
centralstationcrm_deals_projects_get_api_deals_stats
Retrieves key information of deals Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag_id | integer | No | — | Optionally submit a tag ID in order to only see deals tagged with the submitted tag |
tag_name | string | No | — | Optionally submit a tag name in order to only see deals tagged with the submitted tag |
filter | object | No | — | Optionally submit one of the deals 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_deals_projects_get_api_projects
Retrieves all projects 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: date-asc, date-desc, new-asc, new-desc, update-asc, update-desc, state-asc, state-desc, abc-asc, abc-desc |
includes | string | No | — | possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value. |
tag_id | integer | No | — | Optionally submit a tag ID in order to only see projects tagged with the submitted tag |
tag_name | string | No | — | Optionally submit a tag name in order to only see projects tagged with the submitted tag |
stream_updated_at_before | string | No | — | Optionally submit a date or timestamp (ISO 8601) in order to only see projects with activities within the stream earlier than the submitted point in time. |
stream_updated_at_after | string | No | — | Optionally submit a date or timestamp (ISO 8601) in order to only see projects with activities within the stream later than the submitted point in time. |
filter | object | No | — | Optionally submit one of the projects 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_deals_projects_get_api_projects_by_id
Retrieves a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | id |
includes | string | No | — | possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value. |
centralstationcrm_deals_projects_get_api_projects_by_project_id_external_emails
Retrieves all external_emails 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 option: comments |
project_id | integer | Yes | — | ID of the external_emails of the desired project |
centralstationcrm_deals_projects_get_api_projects_by_project_id_external_emails_count
Retrieves total amount of external_emails Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | integer | Yes | — | ID of the external_emails of the desired project |
centralstationcrm_deals_projects_get_api_projects_by_project_id_maildrop
Retrieves the maildrop Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | integer | Yes | — | ID of the project the maildrop belong to |
centralstationcrm_deals_projects_get_api_projects_count
Retrieves total amount of projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag_id | integer | No | — | Optionally submit a tag ID in order to only see projects tagged with the submitted tag |
tag_name | string | No | — | Optionally submit a tag name in order to only see projects tagged with the submitted tag |
filter | object | No | — | Optionally submit one of the projects 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_deals_projects_get_api_projects_search
Retrieves projects matching the search Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perpage | integer | No | — | Elements per page, maximum of 250 |
page | integer | No | — | Retrieve records of the given page |
name | string | No | — | Retrieve projects by their name |
includes | string | No | — | possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value. |
centralstationcrm_deals_projects_get_api_projects_stats
Retrieves key information of projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag_id | integer | No | — | Optionally submit a tag ID in order to only see projects tagged with the submitted tag |
tag_name | string | No | — | Optionally submit a tag name in order to only see projects tagged with the submitted tag |
filter | object | No | — | Optionally submit one of the projects 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_deals_projects_post_api_deals
Creates a basic deal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includes | string | No | — | possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value. |
no_log | boolean | No | — | Set to true if you don’t want to generate a activity for the stream. |
deal | object | No | — | deal |
centralstationcrm_deals_projects_post_api_projects
Creates a basic project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includes | string | No | — | possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the ‘all’ value. |
methods | string | No | — | Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value. |
no_log | boolean | No | — | Set to true if you don’t want to generate a activity for the stream. |
project | object | No | — | project |
centralstationcrm_deals_projects_put_api_deals_by_id
Update a deal 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. |
deal | object | No | — | deal |
centralstationcrm_deals_projects_put_api_projects_by_id
Update a project 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. |
project | object | No | — | project |

