POST subscriptions/update
- Former user (Deleted)
- Joseph Ioannou (Unlicensed)
- Georgia Kountouri
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.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
| subscription_identifier | Subscription Identifier | The subscription to be modified. The allowed subscription identifier fields are the following:
| ||||||||||||
notes (optional) | String | Notes for the subscription to be updated | ||||||||||||
owned_by_group_identifier (optional) | Group identifier | The group that will be owning the subscription. The allowed group identifier fields are the following:
| ||||||||||||
privacy_level_identifier (optional) | Privacy level identifier | The subscription's privacy level. The allowed privacy level identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | ||||||||||||
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 | ||||||||||||
custom_field_set (optional) | Set of Custom Fields | The custom fields that are associated with the subscription If no records are specified in the set then nothing will be updated. To add or update a value on a custom field use the custom field name as configured in CRM.COM along with the respective value. To remove a value from a custom field use the custom field name as configured in CRM.COM along with an empty value "custom_field_set": [
{"field_name" : "value"},
{"field_name" : "value"}
]
Available from CRM.COM R16.2.0 | ||||||||||||
(optional) | Set of subscription service objects | The services that will be updated by modifying one or more of their UDFs Available from CRM.COM-R14.3.0 | ||||||||||||
(optional) | Set of subscription installed item objects | The installed items that will be updated by modifying one or more of their UDFs Available from CRM.COM-R14.3.0 | ||||||||||||
provisioning_distributor_labels_set (optional) | Set of subscription provisioning distributor label objects | The labels that will be applied on the specified provisioning distributor for the specific subscription. Each provisioning distributor can be labeled only once per subscription. Available from CRM.COM R14.5.0 Deprecated from CRM.COM R18.00 | ||||||||||||
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Referred Parameter Objects Data
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token" : "68AE293767E642338983F52D879D56E7",
"subscription_identifier" : { "number" : "S60117"},
"notes" : "Update subscription information through Web API",
"owned_by_group_identifier" : { "name" : "Managers Group"},
"privacy_level_identifier" : { "id" : "BFF5D07F43CAD23390C2B07678FE3074"},
"udf_string_5" : "UDF5"
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Litt",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Louis",
"type": "PERSON",
"id": "401DEC346B0E70A8F0DDD9FC857763FA",
"name": "Litt Louis",
"company_name": null,
"demographics":
{
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence":
{
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day":
{
"month": null,
"day": null
},
"date_of_birth":
{
"month": null,
"day": null,
"year": null
},
"id_number": "154859",
"industry": null,
"id_issued_by_country": null
}
},
"life_cycle_state": "ACTIVE",
"number": "180",
"id": "1C414B9447E158F4CFE85BFE049704E3",
"name": "Louis Litt 2"
},
"life_cycle_state": "EFFECTIVE",
"number": "S60117",
"type":
{
"udf_float_1": null,
"udf_float_2": null,
"udf_date_1": null,
"udf_float_3": null,
"udf_date_2": null,
"udf_float_4": null,
"udf_date_3": null,
"udf_date_4": null,
"name": "United Kingdom",
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"log_information":
{
"updated_date": "2015-02-20T16:40:42",
"created_date": "2014-06-25T15:44:04",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
}
},
"udf_string_8": null,
"id": "1C81FBB1E5D90040F440ECE98D6A368D",
"description": "United Kingdom",
"alternative_code": "UK"
},
"id": "08E04C64110A44FF79F4431E1F4E1765"
}
}