| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| activity_identifier (mandatory) | Activity identifier | The identifier of the activity that should be returned as a result. The allowed activities identifier fields are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
| activity_type_identifier (semi-optional) | Activity type identifier | The identifier of the activity type. The allowed activity type identifier fields are the following:
| ||||||||
| contact_information_identifier (semi-optional) | Contact information identifier | The identifier of the contact information related with the account that will be returned as results. The allowed contact information identifier fields are the following: | V4:contact_information_identifier | V4:contact_information_identifierinformation identifier fields are the following:
| Include Page | ||||
|---|---|---|---|---|
|
number_of_results
(optional)
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
offset
(optional)
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.0.0 |
fields_set
(optional)
List of Strings, comma separated
A list of fields that should be included in the results. If not specified then all the available fields will be returned
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
period (mandatory) | Number | The length of time for which an activity is close to estimated completion | ||||||
| uot (mandatory) | String | The unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS | ||||||
contact_information_identifier (optional) | Contact information identifier | The identifier of the contact information (person or company) for which the retrieved activity is planned for
| ||||||
type_identifier (optional) | Activity type identifier | The identifier of the type of the retrieved activity
| ||||||
category_identifier (optional) | Activity category identifier | The identifier of the category of the retrieved activity
| ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
contact_information_identifier (optional) | Contact information identifier | The identifier of the contact information (person or company) for which the retrieved activity is planned for
| ||||||
type_identifier (optional) | Activity type identifier | The identifier of the type of the retrieved activity
| ||||||
category_identifier (optional) | Activity category identifier | The identifier of the category of the retrieved activity
| ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||||||
token | String | The token retrieved from the login method | ||||||||||
contact_information_identifier (optional) | Contact information identifier | The identifier of the contact information (person or company) for which the retrieved activity is planned for
| ||||||||||
type_identifier (optional) | Activity type identifier | The identifier of the type of the retrieved activity
| ||||||||||
category_identifier (optional) | Activity category identifier | The identifier of the category of the retrieved activity
The identifier of the category of the retrieved activity
| ||||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
contact_information_identifier (optional) | Contact information identifier | The identifier of the contact information (person or company) for which the retrieved activity is planned for
| ||||||
type_identifier (optional) | Activity type identifier | The identifier of the type of the retrieved activity
| ||||||
category_identifier (optional) | Activity category identifier | The identifier of the category of the retrieved activity
| ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
contact_information_identifier (optional) | Contact information identifier | The identifier of the contact information (person or company) for which the retrieved activity is planned for
| ||||||
type_identifier (optional) | Activity type identifier | The identifier of the type of the retrieved activity
| ||||||
category_identifier (optional) | Activity category identifier | The identifier of the category of the retrieved activity
| ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
This method returns information related with cancelled activities. Multiple activities are returned by each call
| Tip |
|---|
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
contact_information_identifier (optional) | Contact information identifier | The identifier of the contact information (person or company) for which the retrieved activity is planned for
| ||||||
type_identifier (optional) | Activity type identifier | The identifier of the type of the retrieved activity
| ||||||
category_identifier (optional) | Activity category identifier | The identifier of the category of the retrieved activity
| ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
type_identifier (mandatory) | Activity Type Identifier | The type of the activity. The allowed activity type identifiers are the following:
| ||||||
contact_information_identifier (mandatory) | Contact Information Identifier | The contact information related with the activity. The allowed contact information identifiers are the following:
| ||||||
category_identifier (optional) | Category Identifier | The category of the activity. The allowed activity category identifiers are the following:
| ||||||
status_identifier (optional) | Activity Status Identifier | The status of the activity. If not specified then the default status will be set automatically.The allowed activity status identifiers are the following:
| ||||||
description (optional) | String | The description of the retrieved activity | ||||||
notes (optional) | String | The notes of the retrieved activity | ||||||
start_date (optional) | Date | The date that the activity will start | ||||||
owned_by_group_identifier (mandatory) | The identifier of the owned by group information | The owned by group information of the activity. The allowed group identifier fields are the following:
| ||||||
privacy_level_identifier (optional) | The identifier of the privacy level | The privacy level of the activity. The allowed privacy level identifier fields are the following:
| ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||
expected_completion_date (semi-optional) | Date | The date that the activity is expected to be completed | ||||||
(semi-optional) | Time Period Object | The time that is estimated to complete the activity, measured in minutes, hours, days, weeks, years | ||||||
(optional) | Assign To Object | The assignment information of the activity | ||||||
(optional) | Performed for Object | The entities which are related with the activity | ||||||
(optional) | Set of Services to be Provided Object | The information related to the services to be provided with the activity | ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
activity_identifier (mandatory) | Activity Identifier | The identifier of the activity to be updated. The allowed activity identifier fields are the following:
| ||||||
category_identifier (optional) | Category Identifier | The category of the activity. The allowed activity category identifiers are the following:
| ||||||
status_identifier (optional) | Activity Status Identifier | The status of the activity. The allowed activity status identifiers are the following:
| ||||||
description (optional) | String | The description of the retrieved activity | ||||||
notes (optional) | String | The notes of the retrieved activity | ||||||
start_date (optional) | Date | The date that the activity will start | ||||||
owned_by_group_identifier (optional) | The identifier of the owned by group information | The owned by group information of the activity. The allowed group identifier fields are the following:
| ||||||
privacy_level_identifier (optional) | The identifier of the privacy level | The privacy level of the activity. The allowed privacy level identifier fields are the following:
| ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||
expected_completion_date (optional) | Date | The date that the activity is expected to be completed | ||||||
(optional) | Time Period Object | The time that is estimated to complete the activity, measured in minutes, hours, days, weeks, years | ||||||
(mandatory on conditions) | Assign To Object | The assignment information of the activity. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules. | ||||||
(optional) | Performed for Object | The entities which are related with the activity
| ||||||
(optional) | Set of Services to be Provided Object | The information related to the services to be provided with the activity
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
This method cancels an activity, which is not already completed or cancelled.
| Tip |
|---|
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
activity_identifier (mandatory) | Activity Identifier | The identifier of the activity to be cancelled. The allowed activity identifier fields are the following:
| ||||||
status_identifier (optional) | Activity Status Identifier | The status that will be set on the activity, after the cancellation. If not specified then the default status for cancelling activities of that type will be used. The allowed activity status identifiers are the following:
| ||||||
cancellation_reason_identifier (mandatory) | Activity Cancellation Reason Identifier | The reason for cancelling the activity. The allowed activity cancellation reason identifiers are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
This method sets an activity in progress. This method can be applied only on pending activities
| Tip |
|---|
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
activity_identifier (mandatory) | Activity Identifier | The identifier of the activity that will be started. The allowed activity identifier fields are the following:
| ||||||
status_identifier (optional) | Activity Status Identifier | The status that will be set on the activity, after starting the progress. If not specified then the default status for starting the progress for that type of activities will be used.The allowed activity status identifiers are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
This method completes an activity, which is already in progress
| Tip |
|---|
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
activity_identifier (mandatory) | Activity Identifier | The identifier of the activity that will be completed. The allowed activity identifier fields are the following:
| ||||||
status_identifier (optional) | Activity Status Identifier | The status that will be set on completing the activity. If not specified then the default status for completing an activity of that type will be used. The allowed activity status identifiers are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...