Versions Compared

Key

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

This method creates a lead.  Single lead can be created by each call.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

contact_email

(mandatory on conditions)

...

The email address of the contact that will be specified on the new lead.

The contact email is mandatory if the Lead Type's Communication settings define that an email commuication will be sent on the new lead's creation.

Tip

Paramerer is mandatory up until CRM.COM R11.0.0. From CRM.COM R11.1.0 this parameter is mandatory on conditions.

...

contact_phone

(mandatory on conditions)

...

The phone of the contact that will be specified on the new lead. The contact phone is mandatory if the Lead Type's Communication settings define that a phone commuication will be sent on the new lead's creation.

Tip

Available from CRM.COM R11.1.0

...

accounts_receivable_identifier

(mandatory on conditions)

...

The accounts receivable that will be related with the lead. This information is mandatory if the specified contact information is already a customer (has an accounts receivable). The specified accounts receivable should be owned by the specified contact information.The allowed accounts receivable identifier fields are the following:

...

description

(optional)

...

probability_to_win

(optional)

...

importance

(mandatory)

...

The importance related with the leads that should be returned as a result. The allowed lead importance fields are the following: IMPORTANCE1, IMPORTANCE2, IMPORTANCE3, IMPORTANCE4, IMPORTANCE5, CUSTOM1, CUSTOM2, CUSTOM3

...

priority

(mandatory)

...

The priority related with the leads that should be returned as a result. The allowed lead priority fields are the following: 1, 2, 3, 4, 5, 6

...

target_amount

(optional)

...

type_identifier

(mandatory)

...


Excerpt

This method creates a lead.  Single lead can be created by each call.

Resource URL

Parameters

...

Restrictions

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

Response Data

...

Examples

...

titleExample 1

HTTP Method: POST

 

Request:   http://host_name/crmapi/rest/v2/leads/create

Body:

...

languagejs

...

Name

Type

Description

token

String

The token retrieved from the login method

contact_email

(mandatory on conditions)

String

The email address of the contact that will be specified on the new lead.

The contact email is mandatory if the Lead Type's Communication settings define that an email commuication will be sent on the new lead's creation.

Tip

Paramerer is mandatory up until CRM.COM R11.0.0. From CRM.COM R11.1.0 this parameter is mandatory on conditions.


contact_phone

(mandatory on conditions)

String

The phone of the contact that will be specified on the new lead. The contact phone is mandatory if the Lead Type's Communication settings define that a phone commuication will be sent on the new lead's creation.

Tip

Available from CRM.COM R11.1.0


accounts_receivable_identifier

(mandatory on conditions)

Accounts Receivable Identifier

The accounts receivable that will be related with the lead. This information is mandatory if the specified contact information is already a customer (has an accounts receivable). The specified accounts receivable should be owned by the specified contact information.The allowed accounts receivable identifier fields are the following:

Include Page

V4

v4:

lead

accounts_

type

receivable_identifier

V4

v4:

lead

accounts_

type

receivable_identifier

status_identifiercategory

description

(optional)

Lead Status Identifier

The status of the lead. If not specified, then the Lead Type's default status on create will be used. The allowed lead status identifier fields are the following:

Include PageV4:lead_status_identifierV4:lead_status_identifier
Tip

The status_identifier input parameter is mandatory up until CRM.COM R11.1.0. From CRM.COM R11.1.0 it becomes optional.

lost_reason_identifier

(mandatory on conditions)

Lead Lost Reason Identifier

The reason that the lead was lost. This information is mandatory and applicable only if the lead is created in a status classified as lost. The allowed lead lost reason identifier fields are the following:

Include PageV4:lead_lost_reason_identifierV4:lead_lost_reason_identifier
Tip

The lost_reason_identifier input parameter becomes deprecated from CRM.COM R11.1.0

StringA description of the lead

probability_to_win

(optional)

NumberThe probability to win the retrieved lead which can vary from 0 to 100

importance

(mandatory)

Lead Importance

The importance related with the leads that should be returned as a result. The allowed lead importance fields are the following: IMPORTANCE1, IMPORTANCE2, IMPORTANCE3, IMPORTANCE4, IMPORTANCE5, CUSTOM1, CUSTOM2, CUSTOM3

priority

(mandatory)

Lead Priority

The priority related with the leads that should be returned as a result. The allowed lead priority fields are the following: 1, 2, 3, 4, 5, 6

target_amount

(optional)

NumberThe amount that is predicted to be gained when winning the retrieved lead

type_identifier

(mandatory)

Lead Type Identifier

The type of the lead. The allowed lead type identifier fields are the following:

Include Page
V4:lead_type_identifier
V4:lead_type_identifier

status_identifier

(optional)

Lead
Category
Status Identifier

The

category

status of the lead. If not specified, then the Lead Type's default

Category

status on create will be used

for the new Lead

. The allowed lead

category

status identifier fields are the following:

Include Page
V4:lead_

category

status_identifier
V4:lead_

category

status_identifier

Tip

The

category

status_identifier input parameter is mandatory up until CRM.COM R11.1.0


owned_by_group

. From CRM.COM R11.1.0 it becomes optional.


lost_reason_identifier

(

optional)

mandatory on conditions)

Lead Lost Reason Identifier

The

identifier of the owned by group informationThe owned by group information of the lead. The allowed group

reason that the lead was lost. This information is mandatory and applicable only if the lead is created in a status classified as lost. The allowed lead lost reason identifier fields are the following:

Include Page
V4:

group

lead_lost_reason_identifier
V4:

group

lead_lost_reason_identifier

privacy_level

Tip

The lost_reason_identifier input parameter becomes deprecated from CRM.COM R11.1.0


category_identifier

(optional)

The identifier of the privacy level
Lead Category Identifier

The

privacy level

category of the lead. If not specified, then the Lead Type's default Category will be used for the new Lead. The allowed

privacy level

lead category identifier fields are the following:

Include Page
V4:

privacy

lead_

level

category_identifier
V4:

privacy

lead_

level

category_identifier

Tip

udf_string_1 

(optional)

String

User Defined Field of type String

udf_string_2 

udf_string_3 

(optional)

String

User Defined Field of type String

udf_string_4 

The category_identifier input parameter is mandatory up until CRM.COM R11.1.0


owned_by_group_identifier
(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6 

(optional)

The identifier of the owned by group information

The owned by group information of the lead. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

privacy_level_identifier
(optional)

String

User Defined Field of type String

The identifier of the privacy level

The privacy level of the lead. The allowed privacy level identifier fields are the following:

Include Page
V4:privacy_level_identifier
V4:privacy_level_identifier

Tip

Deprecated from CRM.COM R18.0.0


lead_ownerUser Identifier

The user which owns the lead. The allowed user identifier fields are the following:

Include Page
V4:user_identifier
V4:user_identifier

Tip

Available from CRM.COM R15.0.0


udf_string_1 

(optional)

String

User Defined Field of type String

udf_string_

7

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_

8

7

(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

start_date
(optional)

DateThe date that the lead is created

expected_completion_date
(semi-optional)

DateThe date that the lead is expected to be completed. It is automatically calculated if estimate completion time is specified.estimated_completion_time
(semi-optional)Time Period ObjectThe time that is estimated to complete the lead , measured in minutes, hours, days, weeks, years. It is automatically calculated if expected completion date is specified.

contact_information

(mandatory)

Contact information objectThe contact information that will be related with the lead

source

(mandatory)

Lead SourceInformation related with the source of the leadassigned_to
(optional)Assigned to objectThe assignment information for the lead. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules.

competitors_set

(optional)

Set of Lead CompetitorsA lists of all possible competitors that can reach the same Lead for the same product/goal.

users_set

(optional)

Set of Lead UsersA list of users that are set as the team involved with the lead

services_set

(optional)

Set of lead Services Objects

A list of services for which the lead was taken for

physical_goods_set

(optional)

Set of lead Physical Goods Objects

A list of the physical goods for which the lead was taken for

subscription_package

(optional)

The Subscription Package Object

The subscription package for which the lead was taken for

Tip

Available from CRM.COM R14

fields_set

(optional)

List of Strings, comma separatedA list of fields that should be included in the results. If not specified then all the available fields will be returned

...

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

start_date
(optional)

DateThe date that the lead is created

expected_completion_date
(semi-optional)

DateThe date that the lead is expected to be completed. It is automatically calculated if estimate completion time is specified.
estimated_completion_time
(semi-optional)
Time Period ObjectThe time that is estimated to complete the lead , measured in minutes, hours, days, weeks, years. It is automatically calculated if expected completion date is specified.

contact_information

(mandatory)

Contact information objectThe contact information that will be related with the lead

source

(mandatory)

Lead SourceInformation related with the source of the lead
assigned_to
(optional)
Assigned to objectThe assignment information for the lead. Assign to information is mandatory to be specified, unless if it is set automatically through ACR rules.

competitors_set

(optional)

Set of Lead Competitors

A lists of all possible competitors that can reach the same Lead for the same product/goal.

Tip

From CRM.COM R18.0.0, Competitors refer to Contact Information Company


users_set

(optional)

Set of Lead UsersA list of users that are set as the team involved with the lead

products_set

(optional)

Set of Lead Products Objects

A list of products for which the lead was taken for

Tip

Available from CRM.COM R18.0.0


services_set

(optional)

Set of lead Services Objects

A list of services for which the lead was taken for

Tip

Deprecated from CRM.COM R18.0.0


physical_goods_set

(optional)

Set of lead Physical Goods Objects

A list of the physical goods for which the lead was taken for

Tip

Deprecated from CRM.COM R18.0.0


subscription_package

(optional)

The Subscription Package Object

The subscription package for which the lead was taken for

Tip

Available from CRM.COM R14


Tip

Deprecated from CRM.COM R18.0.0


fields_set

(optional)

List of Strings, comma separatedA list of fields that should be included in the results. If not specified then all the available fields will be returned

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

Include Page
V4:time_period_parameters
V4:time_period_parameters

Include Page
V4:contact_information_parameters
V4:contact_information_parameters

Include Page
V4:lead_source_parameters
V4:lead_source_parameters

Include Page
V4:assigned_to_parameters
V4:assigned_to_parameters

Include Page
V4:lead_competitor_parameters
V4:lead_competitor_parameters

Include Page
V4:lead_user_parameters
V4:lead_user_parameters

Include Page
V4:lead_service_parameters
V4:lead_service_parameters

Include Page
V4:lead_physical_goods_parameters
V4:lead_physical_goods_parameters

Include Page
V4:lead_product_parameters
V4:lead_product_parameters

Include Page
V4:lead_subscription_packages_parameters
V4:lead_subscription_packages_parameters

Restrictions

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

Response Data

Include Page
V4:lead_complete
V4:lead_complete

Examples

Expand
titleExample 1

HTTP Method: POST


Request:   http://host_name/crmapi/rest/v2/leads/create

Body:

Code Block
languagejs
{
	"token" : "6DACB1A17F5B87C53729C52EB3C365F3",
	"contact_email" : "webapi2@test.com",
	"contact_information" : 
		{ 
			"action" : "new",
			"type" : "PERSON",
			"first_name" : "Filippos",
			"last_name" : "Constantinou",
			"demographics" : {
				"gender" : "FEMALE",
				"id_number" : "121212"
			}
		},
	"probability_to_win" : 58,
	"importance" : "IMPORTANCE2",
	"priority" : 3,
	"type_identifier" : { "name" : "Software Purchase"},
	"target_amount" : 58,
	"status_identifier" : { "name" : "Reach"},
	"category_identifier" : { "name" : "Software Purchase"},
	"owned_by_group_identifier" : { "name" : "CSR Group"},
	"udf_string_5" : "udf_string_5",
	"start_date" : "2015-02-20T17:28:30",
    	"estimated_completion_time" :
        {
            "time_period_value"   : 3,
            "time_period_uot" : "WEEKS"
        },
   	 "assigned_to" :
        {
            "user_identifier" : { "username" : "mpadministrator"}
        },	
	"source" : {
		"type" : "COMMUNICATIONS",
		"source_communications_identifier" : { "number" : "204"}
		},
	"users_set": [
		{
			"user_identifier" : { "username" : "mariosmtest"}
		},
		{
			"user_identifier" : { "id" : "018CA08BC267612F6206D85011FFC5D1"}
		}
	],
	"services_set": [
		{
			"product_identifier" : { "alternative_code" : "SOFA"}
		},
		{
			"product_identifier" : { "code" : "Adult- Only for Additional"}
		}
	],
	"competitors_set" : [
		{
			"competitor_identifier" : { "name" : "Competitor 4"}
		},
		{
			"competitor_identifier" : { "id" : "C671ED66046243565DE5B6B4A1AB5835"}
		}
	],
}


Response:

Code Block
languagejs
    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "actual_completion_date": null,
           "services_set":
           [
               {
                   "product_type": null,
                   "id": "4F8DD6FB68E24919A5F8815E7AFD7C33",
                   "product":
                   {
                       "product_type":
                       {
                           "physical_good_type": null,
                           "service_type": "TERMED",
                           "used_for_provisioning": true,
                           "composition_method": "FLAT",
                           "classification": "SERVICES",
                           "name": "Subscription Packages",
                           "id": "BC954969D3172372D498D3BB2BA590A0",
                           "description": "Subscription main packages",
                           "alternative_code": "SP"
                       },
                       "id": "3FACF409E7E091F96C52318BAD1AEF1C",
                       "description": "Local + Documentaries + Sport",
                       "code": "Local + Documentaries + Sport",
                       "alternative_code": "LDS"
                   }
               },
               {
                   "product_type":
                   {
                       "physical_good_type": null,
                       "service_type": "TERMED",
                       "used_for_provisioning": true,
                       "composition_method": "FLAT",
                       "classification": "SERVICES",
                       "name": "Subscription Packages",
                       "id": "BC954969D3172372D498D3BB2BA590A0",
                       "description": "Subscription main packages",
                       "alternative_code": "SP"
                   },
                   "id": "C51688C39E7846319B668558F9726FDB",
                   "product": null
               }
           ],
           "target_amount": null,
           "udf_float_1": null,
           "udf_float_2": null,
           "udf_float_3": null,
           "number": "69",
           "udf_float_4": null,
           "competitors_set":
           [
               {
                   "id": "C6B7D2D0F81545D6B886B19D67B0C6EE",
                   "competitor":
                   {
                       "website": "www.competitor1.com",
                       "name": "Competitor 1",
                       "id": "C671ED66046243565DE5B6B4A1AB5835",
                       "description": null
                   }
               },
               {
                   "id": "73F11E40288445F7AB347E11A66ED97D",
                   "competitor":
                   {
                       "website": "www.competitor4.com",
                       "name": "Competitor 4",
                       "id": "4DC59EB406F3C3DFDFAD46AF213BFC97",
                       "description": null
                   }
               }
           ],
           "udf_string_1": null,
           "udf_string_2": null,
           "assigned_to":
           {
               "unit":
               {
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "user":
               {
                   "person_name": "Marios Lannister",
                   "username": "mpadministrator",
                   "id": "1",
                   "email": "mp@ministrator.com"
               }
           },
           "estimated_completion_time":
           {
               "time_period_value": 3,
               "time_period_uot": "WEEKS"
           },
           "udf_string_3": null,
           "contact_information":
           {
               "last_name": "Constantinou",
               "life_cycle_state": "MARKETING",
               "middle_name": null,
               "company_profile": null,
               "title": null,
               "type": "PERSON",
               "first_name": "Filippos",
               "name": "Filippos Constantinou",
               "id": "829CA6CAFFAB434C9E1B3FB72BE3DAB1",
               "company_name": null,
               "demographics":
               {
                   "gender": "FEMALE",
                   "passport_issued_by_country": null,
                   "passport_number": null,
                   "social_security_number": null,
                   "country_of_residence":
                   {
                       "name": "UNITED KINGDOM",
                       "id": "126"
                   },
                   "industry_sector": null,
                   "date_of_birth":
                   {
                       "month": null,
                       "day": null,
                       "year": null
                   },
                   "name_day":
                   {
                       "month": null,
                       "day": null
                   },
                   "id_number": "121212",
                   "id_issued_by_country": null,
                   "industry": null
               }
           },
           "privacy_level": null,
           "udf_string_4": null,
           "udf_string_5": "udf_string_5",
           "udf_string_6": null,
           "physical_goods_set":
           [
           ],
           "udf_string_7": null,
           "udf_string_8": null,
           "accounts_receivable": null,
           "id": "DCD9A08C2A4C421EA00FCF84D0974CCA",
           "lead_source":
           {
               "communication":
               {
                   "life_cycle_state": "DRAFT",
                   "number": "204",
                   "id": "0316F16B0700688BCF97CCC9661F4141",
                   "contact_information":
                   {
                       "last_name": "Messi",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": "Andres",
                       "company_profile": null,
                       "title": "Mr",
                       "type": "PERSON",
                       "first_name": "Lionel",
                       "name": null,
                       "id": "0A910B939D30FFC942ECCE4082AF42F8",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "passport_number": "4321",
                           "social_security_number": "12345",
                           "industry_sector": null,
                           "date_of_birth":
                           {
                               "month": 6,
                               "day": 24,
                               "year": 1987
                           },
                           "name_day":
                           {
                               "month": 4,
                               "day": 2
                           },
                           "id_number": "1234",
                           "industry": null
                       }
                   }
               },
               "type": "COMMUNICATIONS"
           },
           "probability_to_win": null,
           "priority": 3,
           "udf_date_1": null,
           "udf_date_2": null,
           "udf_date_3": null,
           "expected_completion_date": "2015-03-13T17:28:30",
           "udf_date_4": null,
           "start_date": "2015-02-20T17:28:30",
           "users_set":
           [
               {
                   "id": "61CC6B0B140149A1A4AD7C57BC2A8FEE",
                   "user":
                   {
                       "person_name": "mm mm",
                       "username": "mariosmtest",
                       "id": "C2730E7C873AB4F5425218BA01378251",
                       "email": null
                   }
               },
               {
                   "id": "97A4844D6A374542AA4BAB46AF599D10",
                   "user":
                   {
                       "person_name": "Super Visor",
                       "username": "supervisor",
                       "id": "018CA08BC267612F6206D85011FFC5D1",
                       "email": "super@visor.com"
                   }
               }
           ],
           "time_overdue":
           {
               "time_period_value": 3,
               "time_period_uot": "DAYS"
           },
           "time_to_completion":
           {
               "time_period_value": null,
               "time_period_uot": null
           },
           "owned_by_group":
           {
               "community_name": "CSR Community",
               "name": "CSR Group",
               "id": "9F53AE96144CB2F358C38BADE9E2F470",
               "description": null,
               "alternative_code": "CSR"
           },
           "log_information":
           {
               "updated_date": "2015-03-16T14:32:25",
               "created_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2015-03-16T14:32:14",
               "updated_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "mpadministrator",
                   "id": "1"
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "time_period_value"mpadministrator",
     : 3,             "time_period_uotid" : "WEEKS1"
        },       	}
"assigned_to" :         { },
           "user_identifierstatus":
:     { "username" : "mpadministrator"}   {
     },	 	"source" : { 		"type" : "COMMUNICATIONS", 		"source_communications_identifier" : { "numbername" : "204Reach"}
		},
	"users_set": [ 		{ 			"user_identifier" : { "username" : "mariosmtest"} 		}, 		{
			"user_identifier" : {     "id" : "018CA08BC267612F6206D85011FFC5D15DA88E4C781244C2CDB0F4F57E2EE875"},
		} 	], 	"services_set": [ 		{ 			"product_identifier" : { "alternative_code" : "SOFA"} 		}, 		{ 			"product_identifier" : { "codedescription" : "Adult-null,
Only for Additional"} 		} 	], 	"competitors_set" : [ 		{ 			"competitor_identifier" : { "name" : "Competitor 4"}
		},
		{
			"competitor_identifier" : { "id" : "C671ED66046243565DE5B6B4A1AB5835"}
		}
	],
}

 

Response:

Code Block
languagejs
"alternative_code": "R"
        {   },
    "status":        {"importance": "IMPORTANCE2",
           "messagelife_cycle_state": null"PENDING",
           "descriptiontype":
null,           {
"code": "OK"        },        "dataname": "Software  Purchase",
    {            "actual_completion_dateid": null,"F60FFE7AAD3F5B9B6E66A42266FA37C4",
               "services_setdescription": null,
          [     "alternative_code": "SP"
           },
    {       "description": null,
           "productcontact_typeemail": null"webapi2@test.com",
           "category":
       "id": "4F8DD6FB68E24919A5F8815E7AFD7C33",    {
               "productname": "Software Purchase",
               "id":  {"C60F332D0B4CB8DD22A0159413951434",
               "description": null,
         "product_type":      "code": "SP"
           },
    {       "lost_reason": null
       }
}



Expand
titleExample 2

HTTP Method: POST


Request:  {{server}}/crmapi/rest/v2/leads/create

Body:

Code Block
languagejs
{
     "token":"{{token}}",
    "physicalcontact_good_typeemail" : null"webapi@test.com",
    "contact_information" :
        {
            "service_typeaction" : "TERMEDnew",
            "type" : "PERSON",
            "usedfirst_for_provisioningname" : true"Philip",
            "last_name" : "Andreou",
            "composition_methoddemographics" : "FLAT", {
                "gender" : "MALE",
                "classificationid_number" : "SERVICES1252512",
            }
        },
     "nameprobability_to_win" : "Subscription Packages"58,
    "importance" : "IMPORTANCE2",
    "priority" : 3,
    "type_identifier" :      {  "idname" : "BC954969D3172372D498D3BB2BA590A0New Customer"},
    "target_amount" : 58,
    "status_identifier" : { "name" : "Learn"},
    "category_identifier" :    { "descriptionname" : "SubscriptionNew main packagesCustomer"},
    "owned_by_group_identifier" : { "name" : "Main Group"},
    "udf_string_5" : "udf_string_5",
         "alternative_code": "SP""start_date" : "2018-01-22T17:28:30",
        "estimated_completion_time" :
        {
     },       "time_period_value"   : 3,
            "idtime_period_uot" : "3FACF409E7E091F96C52318BAD1AEF1CWEEKS",
        },
              "description": "Local + Documentaries + Sport","assigned_to" :
        {
            "user_identifier" :  {    "codeusername" : "Localmpadministrator"}
+ Documentaries + Sport",     },  
    "source" :  {
        "alternative_codetype" : "LDSCOMMUNICATIONS",
        "source_communications_identifier" : { "number" : "204"}
     }   },
   "lead_products_set" :
    [
  },      {
         {   "action" : "add",
              "lead_product_typeidentifier":
          { "product_identifier" : { "code" : "123"}}
        {},
          {
            "physical_good_typeaction" : null"add",
              "lead_product_identifier":{"product_type_identifier"        : { "service_typename" : "TERMED",Additional Services"}}
        },
         {
    "used_for_provisioning": true,       "action" : "add",
              "composition_method""lead_product_identifier":{"product_brand_identifier" : { "name" : "FLAT",Corso Shoes"}}
        },
         {
    "classification": "SERVICES",       "action" : "add",
              "name"lead_product_identifier":{"product_family_identifier" : { "Subscription Packagesname", : "Channels"}}
        }
    ],
    "subscription_package_identifier": {  "idname" : "BC954969D3172372D498D3BB2BA590A0",Simple Package"}
}


Response:

Code Block
languagejs
 {
    "data": {
        "target_amount": 58,
        "descriptioncontact_phone": "Subscription main packages"null,
        "log_information": {
             "alternativecreated_by_codeunit": "SP"{
                   }"alternative_code": "adminunit",
                   "id"group_name": "C51688C39E7846319B668558F9726FDBMain Group",
                  "community_name": "productCommunity":,
null                }
 "name": "Admin Unit",
         ],       "description": "admin unit",
   "target_amount": null,            "udf_float_1id": null,"1"
           "udf_float_2": null },
            "udfupdated_floatby_3unit": null, {
                "numberalternative_code": "69adminunit",
           "udf_float_4": null,    "group_name": "Main Group",
     "competitors_set":            ["community_name": "Community",
               { "name": "Admin Unit",
                "iddescription": "C6B7D2D0F81545D6B886B19D67B0C6EEadmin unit",
  
                "competitorid": "1"
            },
     {           "created_date": "2018-01-22T10:40:25",
            "websiteupdated_date": "www.competitor1.com",2018-01-22T10:40:26",
            "updated_by_user": {
                  "person_name": "CompetitorCRM 1COM",
     
                 "id": "C671ED66046243565DE5B6B4A1AB58351",
      
                "descriptionemail": null,
                "username": "MPAdministrator"
 }                },
               {
  "created_by_user": {
                "idperson_name": "73F11E40288445F7AB347E11A66ED97DCRM COM",
  
                "competitorid": "1",
                "email": null,
{                        "website"username": "www.competitor4.comMPAdministrator",
            }
          "name": "Competitor 4",
             },
         "idimportance": "4DC59EB406F3C3DFDFAD46AF213BFC97IMPORTANCE2",
        "subscription_package": {
             "descriptionsubscription_package": null{
                   }
 "alternative_code": "SP",
             }   "name": "Simple Package",
      ],            "udf_string_1description": null,
                "udf_string_2id": null"0015B6F5645F4454A442051E823E3B4D",
           "assigned_to":     "classification": "PACKAGE"
      {      }
        },
"unit":        "lead_source": {
      {      "type": "COMMUNICATIONS",
            "namecommunication": "Admin Unit",
  {
                 "idviewed_on": "48305F8849E3C18B227C5BE3A27BA6DF"null,

                  "descriptionnumber": "r1204",
  
                "alternative_codesubject": "MG"Your Account has an outstanding amount",
                "viewed": }false,
                "usercontact_information": {
              {      "company_profile": null,
                    "personcompany_name": "Marios: Lannister"null,
                    "usernamename": "mpadministrator"null,
                    "idlast_name": "1Demou",
                    "emailid": "mp@ministrator.comB7D3E4F8A84C45AD919DB3C3E796BACF",
               }     "life_cycle_state": "FINANCIAL",
     },               "estimatedmiddle_completion_timename": null,
          {          "title": null,
    "time_period_value": 3,                "time_period_uottype": "WEEKSPERSON",
           },            "udffirst_string_3name": null"Panayiota",
           "contact_information":         "demographics":   {
               "last_name": "Constantinou",                "lifename_cycle_stateday": "MARKETING",{
               "middle_name": null,                "company_profile"month": null8,
   
           "title": null,                "typeday": "PERSON",
15
              "first_name": "Filippos",         },
      "name": "Filippos Constantinou",                "id_number": "829CA6CAFFAB434C9E1B3FB72BE3DAB13423",
               "company_name         "gender": null"FEMALE",
               "demographics":         "country_of_residence": {
        {                    "genderalternative_code": "FEMALEIRN",
                            "passportthree_issuedcharacter_by_countrycode": null,
                   "passport_number": null,        "name": "IRAN (ISLAMIC REPUBLIC OF)",
       "social_security_number": null,                    "country_of_residenceid": "231",
                  {          "two_character_code": null
            "name": "UNITED KINGDOM",          },
             "id": "126"          "date_of_birth": {
        },                    "industry_sectormonth": null3,
                   "date_of_birth":         "year": 1991,
         {
                       "monthday": null,29
                       "day": null},
                        "yearindustry_sector": null,
                   },     "passport_number": null,
             "name_day":                 "industry": null,
  {                        "month"social_security_number": null"67575",
                        "dayid_issued_by_country": null,
                   },     "passport_issued_by_country": null
             "id_number": "121212",      }
             "id_issued_by_country": null,  },
                 "industryid": null"C49AF93D4ABE4550A57CA82892A4FA67",
               }
  "life_cycle_state": "COMPLETED"
         },   }
        "privacy_level": null},
           "udfowned_stringby_4group": {
null,            "udfalternative_string_5code": "udf_string_5MG",
            "udfcommunity_string_6name": null"Community",
            "physical_goods_setname": "Main Group",
         [   "description": "Main Group",
      ],      "id": "1"
    "udf_string_7": null,   },
        "udf_string_8description": null,
           "accountscontact_receivableinformation": {
null,            "idcompany_profile": "DCD9A08C2A4C421EA00FCF84D0974CCA"null,
            "leadcompany_sourcename": null,
          {  "name": "Philip Andreou",
           "communication":        "last_name": "Andreou",
      {      "id": "303BB59A9FD84B16AF1F3F7E9A184F55",
            "life_cycle_state": "DRAFTMARKETING",
            "middle_name": null,
     "number": "204",      "title": null,
            "idtype": "0316F16B0700688BCF97CCC9661F4141PERSON",
      
            "contactfirst_informationname": "Philip",
                  "demographics": {
                       "last_name"name_day": "Messi",
 {
                     "life_cycle_statemonth": "FINANCIAL"null,
                    "day": null
 "middle_name": "Andres",              },
         "company_profile": null,      "id_number": "1252512",
                "titlegender": "MrMALE",
   
                   "type": "PERSON",
  "country_of_residence": {
                    "firstalternative_namecode": "LionelCYP",
  
                    "namethree_character_code": null"CYP",

                      "idname": "0A910B939D30FFC942ECCE4082AF42F8CYPRUS",
  
                    "company_nameid": null,
  "181",
                    "demographicstwo_character_code": "CY"
                },
     {           "date_of_birth": {
               "gender": "MALE",    "month": null,
                      "passport_numberyear": "4321"null,
                    "day": null
     "social_security_number": "12345",          },
                 "industry_sector": null,
                "passport_number": null,
          "date_of_birth":      "industry": null,
                "social_security_number": null,
  {              "id_issued_by_country": null,
                "monthpassport_issued_by_country": 6,null
            }
         },
        "daytype": 24,{
                  "alternative_code": "NC",
            "yearname": 1987"New Customer",
            "description": null,
             },"id": "696C0E5F273B4D548F875F63F9DE77C2"
        },
        "udf_date_2": null,
        "nameudf_date_day1": null,
        "products_set": [
            {
   {             "product_family": null,
                 "monthproduct": 4null,
                "product_type": null,
                "dayid": "4EB3864B2B3447359DEED714215C6A63",
2                "product_brand": {
          },          "alternative_code": "CS",
                    "id_numbername": "1234Corso Shoes",
      
                    "industrydescription": null,
                    "id": "5A917782ACA648B3BEAF417D1E64C43F"
 }               }
    }        },
       },      {
         "type": "COMMUNICATIONS"      "product_family": null,
    },            "probability_to_winproduct": null,
           "priority": 3,     "product_type": {
       "udf_date_1": null,            "udfmeter_datereading_2type": null,
           "udf_date_3": null,
           "expectedservice_completion_datetype": "2015-03-13T17:28:30TERMED",
             "udf_date_4       "used_for_provisioning": nulltrue,
           "start_date": "2015-02-20T17:28:30",            "usersalternative_setcode": "AS",
          [                {"udr_type": null,
                    "idcomposition_method": "61CC6B0B140149A1A4AD7C57BC2A8FEEFLAT",
                    "username": "Additional Services",
                  {  "description": null,
                    "person_nameid": "mm mmC8321F0BCA8A4051857BC35CEEE41555",
                       "usernameclassification": "mariosmtestSERVICES",
 
                     "idphysical_good_type": "C2730E7C873AB4F5425218BA01378251",null
                },
      "email": null         "id": "B483DBB222634A57AE413960BAB26442",
         }       "product_brand": null
       },     },
          {  {
                 "idproduct_family": "97A4844D6A374542AA4BAB46AF599D10"null,
                   "userproduct": {
                  {  "code": "123",
                    "personproduct_nametype": "Super{
Visor",                        "usernamemeter_reading_type": "supervisor"null,
                        "idservice_type": "018CA08BC267612F6206D85011FFC5D1",
   null,
                   "email": "super@visor.com"         "used_for_provisioning": true,
          }              "alternative_code": "STB",
}            ],            "timeudr_overduetype": null,
          {                "timecomposition_period_valuemethod": 3,"FLAT",
                     "time_period_uot   "name": "DAYSSET TOP BOX",
           },             "time_to_completiondescription": "SET TOP BOX",
        {                "time_period_valueid": null"E8BA9A6F34A24019A89892D5B3ACD9DF",
                 "time_period_uot       "classification": null"PHYSICALGOODS",
            },            "ownedphysical_bygood_grouptype": "TRACEABLE"
          {          },
     "community_name": "CSR Community",                "name"alternative_code": "CSR Group",1_13",
                    "iddescription": "9F53AE96144CB2F358C38BADE9E2F470desc",
                    "descriptionid": null,"99E46901A95B4E31A60BBE67280F2522",
                    "alternativepriority_codelevel": "CSR"null
           },     },
      "log_information":          "product_type": null,
{                "updated_dateid": "2015-03-16T14:32:25C8A7A7CDCE9B4310B04D3A320493B267",
                "createdproduct_by_unitbrand": null
            },
 {           {
        "community_name": "Main Community",
                   "groupproduct_namefamily": "Main{
Group",                    "namecode": "Admin UnitCH",
                    "idname": "48305F8849E3C18B227C5BE3A27BA6DFChannels",
                    "description": "r1"null,
                    "alternative_codeid": "MG5432773B865246E3B10A47CD130183C7"

              },
               "created_date": "2015-03-16T14:32:14",  },
                "updated_by_unitproduct": null,
              {  "product_type": null,
                "community_nameid": "Main CommunityB4867FF0410C4EA99EA919E141F1E610",
                   "groupproduct_namebrand": "Mainnull
Group",            }
       "name": "Admin Unit" ],
        "udf_date_4": null,
         "idcontact_email": "48305F8849E3C18B227C5BE3A27BA6DFwebapi@test.com",
          "udf_date_3": null,
        "descriptionnumber": "r1128",
        "udf_float_3": null,
         "alternativeudf_float_code4": null,
"MG"        "estimated_completion_time": {
      },      "time_period_uot": "WEEKS",
        "created_by_user":    "time_period_value": 3
        },
 {           "probability_to_win": 58,
        "person_nameid": "Marios LannisterA62CF46D154F41E48F0AC77C9EDAC3C2",
        "udf_float_1": null,
         "usernameudf_float_2": "mpadministrator"null,
        "start_date": "2018-01-22T17:28:30",
         "idassigned_to": "1"{
            "unit": {
 },                "updatedalternative_by_usercode": "adminunit",
              {  "group_name": "Main Group",
                "personcommunity_name": "Marios LannisterCommunity",
                   "usernamename": "mpadministratorAdmin Unit",
 
                 "iddescription": "1admin unit",
                }"id": "1"
            },
            "status":
           {user": {
                "person_name": "ReachCRM COM",
                "id": "5DA88E4C781244C2CDB0F4F57E2EE8751",
                "descriptionemail": null,
                "alternative_codeusername": "RMPAdministrator"
            },
           "importance": "IMPORTANCE2"},
           "lifeudf_cyclestring_state2": "PENDING"null,
 
         "typeudf_string_3": null,
        "udf_string_4": null,
{        "actual_completion_date": null,
      "name  "udf_string_5": "Software Purchaseudf_string_5",
        "privacy_level": null,
        "idusers_set": "F60FFE7AAD3F5B9B6E66A42266FA37C4",[],
        "udf_string_1": null,
        "descriptionaccounts_receivable": null,
               "alternative_code"life_cycle_state": "SP"
    IN_PROGRESS",
      },  "priority": 3,
        "descriptiontime_to_completion": {
null,            "contacttime_period_emailuot": "webapi2@test.comWEEKS",
            "categorytime_period_value": 3
        },
 {       "lost_reason": null,
        "namecompetitors_set": "Software Purchase"[],
               "id"time_overdue": "C60F332D0B4CB8DD22A0159413951434",{
               "description"time_period_uot": null,

              "code"time_period_value": "SP"null
           },
           "lost_reason"category": null{
       }
}
Expand
titleExample 1

HTTP Method: POST

 

Request:  {{server}}/crmapi/rest/v2/leads/create

Body:

Code Block
languagejs
{      "tokencode": "{{token}}NC",
            "contact_emailname" : "webapi@test.comNew Customer",
    "contact_information" :       "description": null,
{             "actionid" : "new35EB799C52F14A8984FE2F397A852A78",
        },
   "type" : "PERSON",   "udf_string_6": null,
        "firstexpected_completion_namedate" : "Philip2018-02-12T17:28:30",
        "udf_string_7": null,
     "last_name" : "Andreou",   "udf_string_8": null,
        "status": {
       "demographics" : {   "alternative_code": "LRN",
            "gendername" : "MALELearn",

               "id_number" : "1252512""description": null,
            }
"id": "3602BCD537E94C1C925090F97F3A57FD",
       },     "probabilitylife_tocycle_winstate" : 58,"IN_PROGRESS"
    "importance" : "IMPORTANCE2",  }
  "priority" : 3},
    "type_identifierstatus" : {
"name" : "New Customer"},     "target_amountcode" : 58"OK",
     "status_identifier" : { "namedescription" : "Learn"},
     "category_identifier" : { "namemessage" : "New Customer"},
    "owned_by_group_identifier" : { "name" : "Main Group"},}
}



Expand
titleExample 3

HTTP Method: POST


Request:  {{server}}/crmapi/rest/v2/leads/create

Body:

Code Block
languagejs
{
     "udf_string_5token" : "udf_string_5"{{token}}",
    "startcontact_dateemail" : "2018-01-22T17:28:30webapi@test.com",
        "estimatedcontact_completion_timeinformation" :
        {
            "time_period_valueaction"   : 3"new",
            "time_period_uottype" : "WEEKSPERSON",
        },         "assignedfirst_toname" :         {"Philip",
            "userlast_identifiername" : { "username" : "mpadministrator"}Andreou",
        },       "sourcedemographics" : {
        "type" : "COMMUNICATIONS",         "source_communications_identifiergender" : { "numberMALE",
: "204"}            },    "leadid_products_setnumber" : "1252512"
    [        }
{        },
    "actionprobability_to_win" : "add"58,
    "source":{
        "lead_product_identifiertype":{ "product_identifier" : { "code" : "123"}}OTHER",
        "name":"test"
    
    },
    "importance" : "IMPORTANCE2",
  {  "priority" : 3,
    "type_identifier" : {  "actionname" : "add"3-Play Mall Campaign"},
    "target_amount" :    58,
    "leadstatus_product_identifier":{"product_type_identifier" : { "name" : "Additional ServicesReach"}},
    "category_identifier" : { "name" : "TV Advert"},
        "owned_by_group_identifier" : { "name" :      "Main Group"},
    "actionudf_string_5" : "addudf_string_5",
    "start_date" : "2015-02-20T17:28:30",
        "leadestimated_productcompletion_identifiertime":{"product_brand_identifier" : { "name" : "Corso Shoes"}}
  :
        {
      },      "time_period_value"   : {3,
            "actiontime_period_uot" : "addWEEKS",
        },
        "leadassigned_product_identifier":{"product_family_identifier"to" :
{ "name" : "Channels"}}     {
   }
    ],     "subscriptionuser_package_identifier" : { "nameusername" : "Simple Package"mpadministrator"}
        }
}
 

  


Response:

Code Block
languagejs
  {
    "data": {
        "target_amount": 58,
        "contact_phone": null,
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2018-01-22T1022T12:4050:2537",
            "updated_date": "2018-01-22T1022T12:4051:2602",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            }
        },
        "importance": "IMPORTANCE2",
        "subscription_package": {
            "subscription_package": {
                "alternative_code": "SPBP",
                "name": "SimpleBronze Package",
                "description": null,
                "id": "0015B6F5645F4454A442051E823E3B4DB9EEF5A97F9F4BE690470CDB3FDA1B8C",
                "classification": "PACKAGE"
            }
        },
        "lead_source": {
            "typename": "COMMUNICATIONStest",
            "communicationtype": "OTHER"
{        },
        "viewedowned_by_ongroup": null,
 {
              "numberalternative_code": "204MG",
            "community_name": "Community",
    "subject": "Your Account has an outstanding amount",  "name": "Main Group",
            "vieweddescription": false,
   "Main Group",
            "contact_informationid": {"1"
        },
           "company_profile"description": null,
        "contact_information": {
            "company_nameprofile": null,
            "company_name": null,
      "name": null,     "name": "Philip Andreou",
             "last_name": "DemouAndreou",
    
               "id": "B7D3E4F8A84C45AD919DB3C3E796BACFE450408A11E543028A148AE9926AABD4",
       
            "life_cycle_state": "FINANCIALMARKETING",
       
            "middle_name": null,
     
              "title": null,
       
            "type": "PERSON",
    
               "first_name": "PanayiotaPhilip",
                    "demographics": {
      
                 "name_day": {
   
                        "month": 8null,
   
                        "day": 15null
                        },
    
                   "id_number": "34231252512",
    
                   "gender": "FEMALEMALE",
    
                   "country_of_residence": {
                            "alternative_code": "IRNCYP",
     
                      "three_character_code": null,
   "CYP",
                        "name": "IRAN (ISLAMIC REPUBLIC OF)",
        "CYPRUS",
                    "id": "231181",
       
                    "two_character_code": null"CY"
                },
       },         "date_of_birth": {
              "date_of_birth": {     "month": null,
                      "monthyear": 3null,
                    "day": null
      "year": 1991,         },
                   "day"industry_sector": 29null,
                "passport_number": null,
       },         "industry": null,
                "industrysocial_security_sectornumber": null,
                "id_issued_by_country": null,
                "passport_issued_numberby_country": null,
            }
        },
        "industrytype": {
 null,            "alternative_code": "TPMC",
            "social_security_numbername": "675753-Play Mall Campaign",
            "description": null,
            "id_issued_by_country": null,"2783ED2B25B242A78D450A10818FD54F"
        },
        "udf_date_2": null,
        "passportudf_issueddate_by_country1": null,
        "products_set": [
           } {
                }"product_family": null,
                "idproduct": "C49AF93D4ABE4550A57CA82892A4FA67"null,
                "lifeproduct_cycle_statetype": "COMPLETED"{
            }         }"meter_reading_type": null,
        "owned_by_group": {             "alternativeservice_codetype": "MGTERMED",
     
      "community_name": "Community",             "nameused_for_provisioning": "Main Group",
      true,
     "description": "Main Group",             "idalternative_code": "1AS",
        },            "descriptionudr_type": null,

       "contact_information": {             "companycomposition_profilemethod": null,
   "FLAT",
        "company_name": null,             "name": "PhilipAdditional AndreouServices",
            "last_name": "Andreou",        "description": null,
      "id": "303BB59A9FD84B16AF1F3F7E9A184F55",             "life_cycle_stateid": "MARKETINGC8321F0BCA8A4051857BC35CEEE41555",
             "middle_name": null,       "classification": "SERVICES",
      "title": null,             "physical_good_type": "PERSON", null
               "first_name": "Philip", },
                "demographicsid": {"88D30AC2ABE34B769931FB530E9A8277",
                "nameproduct_daybrand": {null
            },
       "month": null,    {
                "dayproduct_family": null,
                "product": }null,
                "idproduct_numbertype": "1252512"null,
                "genderid": "MALE095EBB9EC3FF42B8B48623BC5DA1BA47",
                "countryproduct_of_residencebrand": {
                    "alternative_code": "CYPCS",
                    "three_character_codename": "CYPCorso Shoes",
                    "namedescription": "CYPRUS"null,
                    "id": "1815A917782ACA648B3BEAF417D1E64C43F",
                }
   "two_character_code": "CY"                 },
   
            "date_of_birth": {

                   "month"product_family": null,
  
                 "yearproduct": null,{
                    "daycode": null"Add On Product",
              },      "product_type": {
         "industry_sector": null,                 "passportmeter_reading_numbertype": null,
                "industry": null,         "service_type": "TERMED",
       "social_security_number": null,                 "idused_issuedfor_by_countryprovisioning": nulltrue,
                "passport_issued_by_country": null       "alternative_code": "AO",
      }         },         "udr_type": {null,
            "alternative_code": "NC",             "namecomposition_method": "New CustomerFLAT",
            "description": null,             "idname": "696C0E5F273B4D548F875F63F9DE77C2Add-ons",
        },         "udf_date_2": null,         "udf_date_1"description": null"Additional products",
        "products_set": [             {  "id": "E2324486B2454B56B054ED8129E3A9C0",
             "product_family": null,          "classification": "SERVICES",
     "product": null,                    "productphysical_good_type": null,
                   "id": "4EB3864B2B3447359DEED714215C6A63", },
                    "productalternative_brandcode": {"AOP",
                    "alternative_codedescription": "CSAdd On Product of type Add-ons",
                    "nameid": "Corso Shoes2D95D67DB9CA438E93CAD054698AC17F",
                    "descriptionpriority_level": null,
                },
   "id": "5A917782ACA648B3BEAF417D1E64C43F"            "product_type": null,
   }              }"id": "7F3A8CDF17574321AD47EAEBC1DD3F46",
            {    "product_brand": null
           "product_family": null },
            {
   "product": null,                 "product_typefamily": {
 null,
                  "meter_reading_type"product": null,{
                    "service_typecode": "TERMEDAbstract Physical Good",
                    "usedproduct_for_provisioning": true,type": {
                        "alternativemeter_reading_codetype": "AS",null,
                        "udrservice_type": null,
                        "compositionused_for_methodprovisioning": "FLAT",true,
                        "namealternative_code": "AdditionalPhysical ServicesGood",
                     "description   "udr_type": null,
                        "idcomposition_method": "C8321F0BCA8A4051857BC35CEEE41555FLAT",
                        "classificationname": "SERVICESPhysical Good",
                    "physical_good_type    "description": null
     ,
          },                 "id": "B483DBB222634A57AE413960BAB264425B6DAF4AD7C94C4D9C3B49950E10B256",
                "product_brand": null             },
 "classification": "PHYSICALGOODS",
          {                 "productphysical_good_familytype": null, "TRACEABLE"
                   "product": { },
                    "alternative_code": "123APG",
                    "product_typedescription": {
 "Abstract Physical Good",
                    "meter_reading_typeid": null"754BEFEB2C324667A869808E1E7A350F",
 
                      "servicepriority_typelevel": null,
                },
       "used_for_provisioning": true,        "product_type": null,
                "alternative_codeid": "STB9BFDFB209BB645EC99690ED58486C9D8",
     
                  "udrproduct_typebrand": null,
            }
           "composition_method": "FLAT"],
               "udf_date_4": null,
        "namecontact_email": "SET TOP BOXwebapi@test.com",
            "udf_date_3": null,
           "descriptionnumber": "SET TOP BOX132",
             "udf_float_3": null,
          "id"udf_float_4": "E8BA9A6F34A24019A89892D5B3ACD9DF"null,

          "estimated_completion_time": {
            "classificationtime_period_uot": "PHYSICALGOODSWEEKS",
           
            "physicaltime_goodperiod_typevalue": "TRACEABLE"3
        },
           }"probability_to_win": 58,
        "id": "5D4919E5C6F54F27ABC37AECFA5FE8AC",
          "alternativeudf_float_code1": "1_13"null,
        "udf_float_2": null,
          "descriptionstart_date": "desc2015-02-20T17:28:30",
        "assigned_to": {
            "idunit": "99E46901A95B4E31A60BBE67280F2522",
{
                   "priorityalternative_levelcode": "adminunit",
null                 }"group_name": "Main Group",
                "productcommunity_typename": null"Community",
                "idname": "Admin Unit"C8A7A7CDCE9B4310B04D3A320493B267",
                "product_branddescription": null "admin unit",
             },   "id": "1"
        {    },
            "product_familyuser": {
   
                "codeperson_name": "CHCRM COM",
  
                 "nameid": "Channels1",
   
                "descriptionemail": null,
                    "idusername": "5432773B865246E3B10A47CD130183C7MPAdministrator"
            }
   },     },
           "product"udf_string_2": null,
                "product_type"udf_string_3": null,
 
              "id"udf_string_4": "B4867FF0410C4EA99EA919E141F1E610",
       null,
        "productactual_completion_branddate": null,
            }
        ]"udf_string_5": "udf_string_5",
        "udf_dateprivacy_4level": null,
        "contactusers_emailset": "webapi@test.com"[],
        "udf_datestring_31": null,
        "numberaccounts_receivable": "128"null,
        "udflife_floatcycle_3state": null"PENDING",
        "udf_float_4priority": null3,
        "estimatedtime_to_completion_time": {
            "time_period_uot": "WEEKS",
            "time_period_value": 3
        },
        "probabilitylost_to_winreason": 58null,
        "idcompetitors_set": "A62CF46D154F41E48F0AC77C9EDAC3C2",[
        "udf_float_1": null,   {
     "udf_float_2": null,         "start_date": "2018-01-22T17:28:30",
        "assigned_to "competitor": {
        
   "unit": {                 "alternative_codewebsite": "adminunitZuora.com",
                    "group_name": "Main GroupZuora",
                    "community_namedescription": "Community",null,
                    "nameid": "Admin Unit0CC8A3BDCA7B41B78058D0A178390B06",
                "description": "admin unit"},
                "id": "1D6A0C981F18642D1B1DBAD040CD5CEE5"
            },
            {
   "user             "competitor": {
                    "person_namewebsite": "CRM COM",null,
                    "idname": "1MagnaQuest",
                    "emaildescription": null,
                    "usernameid": "MPAdministrator640A12797E964BFC99F8AF0EA538EEEA"
                },
        },        "id": "udf_string_2": null,46DCBC25DBD846FFA3598C7B21264B41"
           "udf_string_3": null },
        "udf_string_4": null,    {
      "actual_completion_date": null,         "udf_string_5competitor": "udf_string_5",{
          "privacy_level": null,         "users_setwebsite": []"Chargify.com",
        "udf_string_1": null,            "accounts_receivablename": null"Chargify",
        "life_cycle_state": "IN_PROGRESS",            "prioritydescription": 3null,
        "time_to_completion": {             "time_period_uot"id": "WEEKS02376768970343738D736979A1DE0C52",
              "time_period_value": 3 },
       },         "lost_reasonid": null,
 "C6AB17DC99214869A811611F51A54871"
            }
       "competitors_set": [],
        "time_overdue": {
            "time_period_uot": null"YEARS",
            "time_period_value": null2.8657534246575342
        },
        "category": {
            "code": "NCTA",
            "name": "NewTV CustomerAdvert",
            "description": null,
            "id": "35EB799C52F14A8984FE2F397A852A78614B3A5B38A942E6A74052C4F4606573"
        },
        "udf_string_6": null,
        "expected_completion_date": "20182015-0203-12T1713T17:28:30",
        "udf_string_7": null,
        "udf_string_8": null,
        "status": {
            "alternative_code": "LRNRCH",
            "name": "LearnReach",
            "description": null,
            "id": "3602BCD537E94C1C925090F97F3A57FDE9977550B9AA4DB78E08379B0F744E5A",
            "life_cycle_state": "IN_PROGRESSPENDING"
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}


...