Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This method
Excerpt
Excerpt

This method is used to update information related with an existing subscription. Note that services, installed items or billing terms cannot be updated through this method; there are specific methods that should be used in order to perform those actions. 

...

The subscription's privacy level. The allowed privacy level identifier fields are the following:

V4:privacy_level_identifier1float_2udf_float_4udf_date_2 

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifierSubscription Identifier

The subscription to be modified. The allowed subscription identifier fields are the following:

 

Include Page
V4:subscription_identifier
V4:subscription_identifier

notes

(optional)

 StringNotes for the subscription to be updated

owned_by_groupby_group_identifier

(optional)

Group identifier

The group that will be owning the subscription. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

privacy_level_identifier

(optional)

Group Privacy level identifier

The group that will be owning the subscriptionsubscription's privacy level. The allowed group privacy level identifier fields are the following:

Include Page
V4:group_identifierV4:group_identifier
privacy_level_identifier
privacy_level_identifier
V4:privacy_level_identifier

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)

Privacy level identifier
Include Page
V4:privacy_level_identifierString

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_2 7

(optional)

String

User Defined Field of type String

udf_string_3 8

(optional)

String

User Defined Field of type String

udf_string_4 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)

String

Float

User Defined Field of type StringFloat

udf_stringfloat_54

(optional)

String

Float

User Defined Field of type StringFloat

udf_stringdate_61 

(optional)

String

Date

User Defined Field of type StringDate

udf_stringdate_72 

(optional)

String

Date

User Defined Field of type StringDate

udf_stringdate_83

(optional)

String

Date

User Defined Field of type StringDate

udf_floatdate_14

(optional)

FloatDate

User Defined Field of type FloatDateudf

services_

set

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

Set of subscription service objects

The services that will be updated by modifying one or more of their UDFs

Tip

Available from CRM.COM-R14.3.0

installed_items_set

(optional)

Float

User Defined Field of type Float

udf_date_1 

(optional)

Date

User Defined Field of type Date

Set of subscription installed item objects

The installed items that will be updated by modifying one or more of their UDFs

Tip

Available from CRM.COM-R14.3.0

fields_set

(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

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

 

Tip

Available from CRM.COM R10.0.0

Restrictions

...

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

 

Tip

Available from CRM.COM R10.0.0

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Anchor
subscription_update referred objects parameters
subscription_update referred objects parameters
Referred Parameter Objects Data

Include Page
V4:existing_subscription_service_update_parameter
V4:existing_subscription_service_update_parameter

Include Page
V4:existing_subscription_installed_item_update_parameter
V4:existing_subscription_installed_item_update_parameter

Response Data

Include Page
V4:subscription_short
V4:subscription_short

...