Page Comparison

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)

...

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

...

status_identifier

(optional)

...

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:

...

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)

...

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:

...

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

...

category_identifier

(optional)

...

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

...

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

...

title	Example 1

HTTP Method: POST

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

Body:

...

language	js

...

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

owned

accounts_

by

receivable_

group_

identifier

(

optionalThe owned by group information of the lead. The allowed group

mandatory on conditions)

The identifier of the owned by group information

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:

group

accounts_receivable_identifier

V4

	v4:

group_identifierprivacy_levelThe privacy level of the lead. The allowed privacy level identifier

accounts_receivable_identifier

description

(optional)

The identifier of the privacy level

String

A description of the lead

probability_to_win

(optional)

Number

The 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:

Include PageV4:privacy_level_identifierV4:privacy_level_identifierudf_string_1

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

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)

String

User Defined Field of type String

Number

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

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

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_packages

(optional)

Set of lead Subscription Packages Objects

A list of the subscription packages 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

...

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 Page

	V4:lead_status_identifier
	V4: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 Page

	V4:lead_lost_reason_identifier
	V4:lead_lost_reason_identifier

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

category_identifier

(optional)

Lead Category Identifier

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

Include Page

	V4:lead_category_identifier
	V4:lead_category_identifier

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

owned_by_group_identifier
(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)

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_owner

User 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_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

start_date
(optional)

Date

The date that the lead is created

expected_completion_date
(semi-optional)

Date

The 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 Object

The 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 object

The contact information that will be related with the lead

source

(mandatory)

Lead Source

Information related with the source of the lead

assigned_to
(optional)

Assigned to object

The 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 Users

A 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 separated

A 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

title	Example 1

HTTP Method: POST

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

Body:

Code Block

language	js

{
	"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

language	js

    {
       "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": "mpadministrator",
                   "id": "1"
               }
           },
           "status":
           {
               "name": "Reach",
               "id": "5DA88E4C781244C2CDB0F4F57E2EE875",
               "description": null,
               "alternative_code": "R"
           },
           "importance": "IMPORTANCE2",
           "life_cycle_state": "PENDING",
           "type":
           {
               "name": "Software Purchase",
               "id": "F60FFE7AAD3F5B9B6E66A42266FA37C4",
               "description": null,
               "alternative_code": "SP"
           },
           "description": null,
           "contact_email": "webapi2@test.com",
           "category":
           {
               "name": "Software Purchase",
               "id": "C60F332D0B4CB8DD22A0159413951434",
               "description": null,
               "code": "SP"
           },
           "lost_reason": null
       }
}

Expand

title	Example 2

HTTP Method: POST

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

Body:

Code Block

language	js

{
     "token":"{{token}}",
    "contact_email" : "webapi@test.com",
    "contact_information" :
        {
            "action" : "new",
            "type" : "PERSON",
            "first_name" : "Philip",
            "last_name" : "Andreou",
            "demographics" : {
                "gender" : "MALE",
                "id_number" : "1252512"
            }
        },
    "probability_to_win" : 58,
    "importance" : "IMPORTANCE2",
    "priority" : 3,
    "type_identifier" : { "name" : "New Customer"},
    "target_amount" : 58,
    "status_identifier" : { "name" : "Learn"},
    "category_identifier" : { "name" : "New Customer"},
    "owned_by_group_identifier" : { "name" : "Main Group"},
    "udf_string_5" : "udf_string_5",
    "start_date" : "2018-01-22T17: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"}
        },
   "lead_products_set" :
    [
        {
            "action" : "add",
           "lead_product_identifier":{ "product_identifier" : { "code" : "123"}}
        },
         {
            "action" : "add",
              "lead_product_identifier":{"product_type_identifier" : { "name" : "Additional Services"}}
        },
         {
            "action" : "add",
              "lead_product_identifier":{"product_brand_identifier" : { "name" : "Corso Shoes"}}
        },
         {
            "action" : "add",
              "lead_product_identifier":{"product_family_identifier" : { "name" : "Channels"}}
        }
    ],
    "subscription_package_identifier": { "name" : "Simple Package"}
}

Response:

Code Block

language	js

 {
    "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-22T10:40:25",
            "updated_date": "2018-01-22T10:40:26",
            "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": "SP",
                "name": "Simple Package",
                "description": null,
                "id": "0015B6F5645F4454A442051E823E3B4D",
                "classification": "PACKAGE"
            }
        },
        "lead_source": {
            "type": "COMMUNICATIONS",
            "communication": {
                "viewed_on": null,
                "number": "204",
                "subject": "Your Account has an outstanding amount",
                "viewed": false,
                "contact_information": {
                    "company_profile": null,
                    "company_name": null,
                    "name": null,
                    "last_name": "Demou",
                    "id": "B7D3E4F8A84C45AD919DB3C3E796BACF",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Panayiota",
                    "demographics": {
                        "name_day": {
                            "month": 8,
                            "day": 15
                        },
                        "id_number": "3423",
                        "gender": "FEMALE",
                        "country_of_residence": {
                            "alternative_code": "IRN",
                            "three_character_code": null,
                            "name": "IRAN (ISLAMIC REPUBLIC OF)",
                            "id": "231",
                            "two_character_code": null
                        },
                        "date_of_birth": {
                            "month": 3,
                            "year": 1991,
                            "day": 29
                        },
                        "industry_sector": null,
                        "passport_number": null,
                        "industry": null,
                        "social_security_number": "67575",
                        "id_issued_by_country": null,
                        "passport_issued_by_country": null
                    }
                },
                "id": "C49AF93D4ABE4550A57CA82892A4FA67",
                "life_cycle_state": "COMPLETED"
            }
        },
        "owned_by_group": {
            "alternative_code": "MG",
            "community_name": "Community",
            "name": "Main Group",
            "description": "Main Group",
            "id": "1"
        },
        "description": null,
        "contact_information": {
            "company_profile": null,
            "company_name": null,
            "name": "Philip Andreou",
            "last_name": "Andreou",
            "id": "303BB59A9FD84B16AF1F3F7E9A184F55",
            "life_cycle_state": "MARKETING",
            "middle_name": null,
            "title": null,
            "type": "PERSON",
            "first_name": "Philip",
            "demographics": {
                "name_day": {
                    "month": null,
                    "day": null
                },
                "id_number": "1252512",
                "gender": "MALE",
                "country_of_residence": {
                    "alternative_code": "CYP",
                    "three_character_code": "CYP",
                    "name": "CYPRUS",
                    "id": "181",
                    "two_character_code": "CY"
                },
                "date_of_birth": {
                    "month": null,
                    "year": null,
                    "day": null
                },
                "industry_sector": null,
                "passport_number": null,
                "industry": null,
                "social_security_number": null,
                "id_issued_by_country": null,
                "passport_issued_by_country": null
            }
        },
        "type": {
            "alternative_code": "NC",
            "name": "New Customer",
            "description": null,
            "id": "696C0E5F273B4D548F875F63F9DE77C2"
        },
        "udf_date_2": null,
        "udf_date_1": null,
        "products_set": [
            {
                "product_family": null,
                "product": null,
                "product_type": null,
                "id": "4EB3864B2B3447359DEED714215C6A63",
                "product_brand": {
                    "alternative_code": "CS",
                    "name": "Corso Shoes",
                    "description": null,
                    "id": "5A917782ACA648B3BEAF417D1E64C43F"
                }
            },
            {
                "product_family": null,
                "product": null,
                "product_type": {
                    "meter_reading_type": null,
                    "service_type": "TERMED",
                    "used_for_provisioning": true,
                    "alternative_code": "AS",
                    "udr_type": null,
                    "composition_method": "FLAT",
                    "name": "Additional Services",
                    "description": null,
                    "id": "C8321F0BCA8A4051857BC35CEEE41555",
                    "classification": "SERVICES",
                    "physical_good_type": null
                },
                "id": "B483DBB222634A57AE413960BAB26442",
                "product_brand": null
            },
            {
                "product_family": null,
                "product": {
                    "code": "123",
                    "product_type": {
                        "meter_reading_type": null,
                        "service_type": null,
                        "used_for_provisioning": true,
                        "alternative_code": "STB",
                        "udr_type": null,
                        "composition_method": "FLAT",
                        "name": "SET TOP BOX",
                        "description": "SET TOP BOX",
                        "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "alternative_code": "1_13",
                    "description": "desc",
                    "id": "99E46901A95B4E31A60BBE67280F2522",
                    "priority_level": null
                },
                "product_type": null,
                "id": "C8A7A7CDCE9B4310B04D3A320493B267",
                "product_brand": null
            },
            {
                "product_family": {
                    "code": "CH",
                    "name": "Channels",
                    "description": null,
                    "id": "5432773B865246E3B10A47CD130183C7"
                },
                "product": null,
                "product_type": null,
                "id": "B4867FF0410C4EA99EA919E141F1E610",
                "product_brand": null
            }
        ],
        "udf_date_4": null,
        "contact_email": "webapi@test.com",
        "udf_date_3": null,
        "number": "128",
        "udf_float_3": null,
        "udf_float_4": null,
        "estimated_completion_time": {
            "time_period_uot": "WEEKS",
            "time_period_value": 3
        },
        "probability_to_win": 58,
        "id": "A62CF46D154F41E48F0AC77C9EDAC3C2",
        "udf_float_1": null,
        "udf_float_2": null,
        "start_date": "2018-01-22T17:28:30",
        "assigned_to": {
            "unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "time_period_uotdescription" : "WEEKSadmin unit",
         },       	"id": "assigned_to1"
  :          {},
            "user_identifier" : {
 "username" : "mpadministrator"}         },	 	"source" : { 		"typeperson_name" : "COMMUNICATIONSCRM COM",
		"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

language	js

    {                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            }
        },
        "statusudf_string_2": null,
      {  "udf_string_3": null,
        "messageudf_string_4": null,
  
        "descriptionactual_completion_date": null,
  
        "codeudf_string_5": "OKudf_string_5",
       },  "privacy_level": null,
        "datausers_set": [],
      {  "udf_string_1": null,
        "actualaccounts_completion_datereceivable": null,
           "services_set"life_cycle_state": "IN_PROGRESS",
        "priority": 3,
[        "time_to_completion": {
      {      "time_period_uot": "WEEKS",
            "producttime_period_typevalue": null,3
        },
          "idlost_reason": "4F8DD6FB68E24919A5F8815E7AFD7C33"null,
 
                 "product":
    "competitors_set": [],
        "time_overdue": {
    {        "time_period_uot": null,
              "producttime_period_typevalue": null
        },
             "category": {
            "code": "NC",
             "physical_good_typename": null"New Customer",
            "description": null,
             "service_typeid": "TERMED35EB799C52F14A8984FE2F397A852A78",
        },
        "udf_string_6": null,
        "usedexpected_forcompletion_provisioningdate": true"2018-02-12T17:28:30",
           "udf_string_7": null,
               "composition_method"udf_string_8": "FLAT"null,
             "status": {
             "classificationalternative_code": "SERVICESLRN",
              "name": "Learn",
            "namedescription": "Subscription Packages"null,
              "id": "3602BCD537E94C1C925090F97F3A57FD",
            "idlife_cycle_state": "BC954969D3172372D498D3BB2BA590A0IN_PROGRESS",
        }
    },
    "status": {
        "descriptioncode": "Subscription main packagesOK",
        "description": "",
        "message": ""
    }
}

Expand

title	Example 3

HTTP Method: POST

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

Body:

Code Block

language	js

{
 "alternative_code    "token": "SP"{{token}}",
    "contact_email" : "webapi@test.com",
    "contact_information" :
        {
   },         "action" : "new",
            "idtype" : "3FACF409E7E091F96C52318BAD1AEF1CPERSON",
            "first_name" : "Philip",
            "descriptionlast_name" : "Local + Documentaries + SportAndreou",
            "demographics" : {
        "code": "Local + Documentaries + Sport",   "gender" : "MALE",
                  "alternativeid_codenumber" : "LDS1252512"
            }
      }  },
    "probability_to_win" : 58,
    "source":{
 },       "type":"OTHER",
        {"name":"test"
    
    },
    "importance" :    "product_type":"IMPORTANCE2",
    "priority" : 3,
    "type_identifier" : { "name" : "3-Play Mall Campaign"},
{    "target_amount" : 58,
    "status_identifier" : { "name" : "Reach"},
    "category_identifier" : { "physical_good_typename" : null"TV Advert"},
    "owned_by_group_identifier" : { "name" : "Main Group"},
    "udf_string_5" : "udf_string_5",
     "servicestart_typedate" : "TERMED2015-02-20T17:28:30",
        "estimated_completion_time" :
        {
    "used_for_provisioning": true,       "time_period_value"   : 3,
            "compositiontime_period_methoduot" : "FLATWEEKS",
            },
          "classificationassigned_to" :
"SERVICES",        {
            "user_identifier" : { "nameusername" : "Subscription Packagesmpadministrator",}
        }
}

Response:

Code Block

language	js

 {
    "data": {
    "id    "target_amount": "BC954969D3172372D498D3BB2BA590A0"58,
        "contact_phone": null,
        "log_information": {
   "description": "Subscription main packages",      "created_by_unit": {
                "alternative_code": "SPadminunit",
                "group_name": "Main  },
  Group",
                "idcommunity_name": "C51688C39E7846319B668558F9726FDBCommunity",
                   "productname": null"Admin Unit",
              }  "description": "admin unit",
       ],            "target_amountid": null,"1"
           "udf_float_1": null },
            "udfupdated_floatby_2unit": null,{
           "udf_float_3": null,            "number"alternative_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-22T12:50:37",
            "websiteupdated_date": "www.competitor1.com",2018-01-22T12:51:02",
            "updated_by_user": {
                "person_name": "CompetitorCRM 1COM",
                       "id": "C671ED66046243565DE5B6B4A1AB58351",
                "email": null,
     "description": null          "username": "MPAdministrator"
        }    },
           },
  "created_by_user": {
             {   "person_name": "CRM COM",
                "id": "73F11E40288445F7AB347E11A66ED97D1",
                "email": null,
 "competitor":               "username": "MPAdministrator"
      {      }
        },
        "websiteimportance": "www.competitor4.comIMPORTANCE2",
          "subscription_package": {
            "namesubscription_package": {
   "Competitor 4",            "alternative_code": "BP",
          "id": "4DC59EB406F3C3DFDFAD46AF213BFC97",     "name": "Bronze Package",
                "description": null,
                "id": "B9EEF5A97F9F4BE690470CDB3FDA1B8C",
 }                }"classification": "PACKAGE"
           ], }
          "udf_string_1": null},
           "udflead_string_2source": null,{
            "assigned_toname": "test",
          {  "type": "OTHER"
        },
   "unit":     "owned_by_group": {
         {       "alternative_code": "MG",
            "community_name": "Admin UnitCommunity",
    
              "idname": "48305F8849E3C18B227C5BE3A27BA6DFMain Group",

                  "description": "r1Main Group",
      
            "alternative_codeid": "MG1"
        },
        "description": }null,
        "contact_information": {
     "user":       "company_profile": null,
       {       "company_name": null,
            "person_name": "MariosPhilip LannisterAndreou",
  
                "username"last_name": "mpadministratorAndreou",
      
            "id": "1E450408A11E543028A148AE9926AABD4",
                   "email"life_cycle_state": "mp@ministrator.comMARKETING",
            "middle_name": null,
  }          "title": null,
},            "estimated_completion_timetype": "PERSON",
          {  "first_name": "Philip",
            "time_period_valuedemographics": 3,{
                "timename_period_uotday": "WEEKS"
{
          },            "udf_string_3"month": null,
           "contact_information":         "day": null
 {                "last_name": "Constantinou",},
                "lifeid_cycle_statenumber": "MARKETING1252512",
                "middle_namegender": null"MALE",
                "companycountry_of_profileresidence": null,{
               "title": null,       "alternative_code": "CYP",
        "type": "PERSON",                "firstthree_character_namecode": "FilipposCYP",
                    "name": "Filippos ConstantinouCYPRUS",
                    "id": "829CA6CAFFAB434C9E1B3FB72BE3DAB1181",
               "company_name": null,     "two_character_code": "CY"
                },
 "demographics":               "date_of_birth": {
                    "gendermonth": "FEMALE"null,
                   "passport_issued_by_country "year": null,
                    "passport_numberday": null,
                   "social_security_number": null,
  },
                "countryindustry_of_residencesector": null,
                "passport_number": null,
 {               "industry": null,
        "name": "UNITED KINGDOM",        "social_security_number": null,
                 "id_issued_by_country": "126"null,
                "passport_issued_by_country": null
   },         }
        },
 "industry_sector": null,      "type": {
            "datealternative_of_birthcode": "TPMC",
            "name": "3-Play Mall Campaign",
  {          "description": null,
            "monthid": "2783ED2B25B242A78D450A10818FD54F"
 null,       },
        "udf_date_2": null,
        "dayudf_date_1": null,
        "products_set": [
            {
"year": null                    }"product_family": null,
                   "name_day"product": null,
                 "product_type": {
                       "month"meter_reading_type": null,
                      "service_type": "dayTERMED":,
 null                    },"used_for_provisioning": true,
                    "idalternative_numbercode": "121212AS",
                    "id_issued_by_countryudr_type": null,
                    "industrycomposition_method": null"FLAT",
                 }   "name": "Additional Services",
      },              "privacy_leveldescription": null,
 
         "udf_string_4": null,            "udf_string_5id": "udf_string_5C8321F0BCA8A4051857BC35CEEE41555",
           "udf_string_6": null,
           "physical_goods_set":
           [
 "classification": "SERVICES",
         ],            "udfphysical_stringgood_7type": null,
           "udf_string_8": null,        },
   "accounts_receivable": null,            "id": "DCD9A08C2A4C421EA00FCF84D0974CCA88D30AC2ABE34B769931FB530E9A8277",
                "leadproduct_sourcebrand": null
          {  },
             "communication":{
               { "product_family": null,
                 "life_cycle_stateproduct": "DRAFT"null,
                   "number"product_type": "204",
  null,
                "id": "0316F16B0700688BCF97CCC9661F4141095EBB9EC3FF42B8B48623BC5DA1BA47",
                   "contactproduct_informationbrand":
                   {
                       "lastalternative_namecode": "MessiCS",
                       "life_cycle_state"name": "FINANCIAL",
 Corso Shoes",
                     "middle_namedescription": "Andres"null,
                    "id": "5A917782ACA648B3BEAF417D1E64C43F"
   "company_profile": null,            }
           "title": "Mr" },
            {
          "type": "PERSON",      "product_family": null,
                "first_nameproduct": "Lionel",
{
                      "namecode": null,"Add On Product",
                     "idproduct_type": {
"0A910B939D30FFC942ECCE4082AF42F8",                        "companymeter_reading_nametype": null,
                        "demographicsservice_type": "TERMED",
                      {  "used_for_provisioning": true,
                        "genderalternative_code": "MALEAO",
                           "passportudr_numbertype": "4321"null,
                           "socialcomposition_security_numbermethod": "12345FLAT",
  
                        "industry_sectorname": null"Add-ons",
                           "date_of_birth"description": "Additional products",
                         {
  "id": "E2324486B2454B56B054ED8129E3A9C0",
                            "monthclassification": 6"SERVICES",
                        "physical_good_type": null
        "day": 24,           },
                    "yearalternative_code": 1987"AOP",
                    "description": "Add On Product of   },
      type Add-ons",
                    "name_dayid": "2D95D67DB9CA438E93CAD054698AC17F",
                    "priority_level": null
    {             },
                  "monthproduct_type": 4null,
                "id": "7F3A8CDF17574321AD47EAEBC1DD3F46",
             "day   "product_brand": 2 null
            },
            {
},                "product_family": null,
          "id_number": "1234",      "product": {
                    "industrycode": null"Abstract Physical Good",
                     }"product_type": {
                   }     "meter_reading_type": null,
         },
               "service_type": "COMMUNICATIONS"null,
            },            "probabilityused_tofor_winprovisioning": nulltrue,
           "priority": 3,            "udfalternative_date_1code": null"Physical Good",
           "udf_date_2": null,            "udfudr_date_3type": null,
           "expected_completion_date": "2015-03-13T17:28:30",            "udfcomposition_date_4method": null"FLAT",
           "start_date": "2015-02-20T17:28:30",            "users_setname": "Physical Good",
           [             "description": null,
    {                    "id": "61CC6B0B140149A1A4AD7C57BC2A8FEE5B6DAF4AD7C94C4D9C3B49950E10B256",
                        "userclassification": "PHYSICALGOODS",
                  {      "physical_good_type": "TRACEABLE"
                "person_name": "mm mm",   },
                    "usernamealternative_code": "mariosmtestAPG",
                       "iddescription": "C2730E7C873AB4F5425218BA01378251Abstract Physical Good",
                    "id": "754BEFEB2C324667A869808E1E7A350F",
 "email": null                  "priority_level": null
}                },
               { "product_type": null,
                 "id": "97A4844D6A374542AA4BAB46AF599D109BFDFB209BB645EC99690ED58486C9D8",
                   "user"product_brand": null
             }
    {     ],
        "udf_date_4": null,
        "personcontact_nameemail": "Super Visorwebapi@test.com",
        "udf_date_3": null,
             "usernamenumber": "supervisor132",
        "udf_float_3": null,
        "udf_float_4": null,
        "idestimated_completion_time": "018CA08BC267612F6206D85011FFC5D1", {
            "time_period_uot": "WEEKS",
            "emailtime_period_value": "super@visor.com"3
        },
        "probability_to_win": 58,
  }      "id": "5D4919E5C6F54F27ABC37AECFA5FE8AC",
        }
"udf_float_1": null,
          ]"udf_float_2": null,
           "timestart_overduedate": "2015-02-20T17:28:30",
        "assigned_to":  {
               "time_period_value"unit": 3,{
                "timealternative_period_uotcode": "DAYSadminunit"
 ,
         },            "timegroup_to_completionname": "Main Group",
         {
               "timecommunity_period_valuename": null"Community",
                "time_period_uotname": null
 "Admin Unit",
         },            "owned_by_group"description": "admin unit",
         {       "id": "1"
       "community_name": "CSR Community",    },
            "nameuser": "CSR{
Group",                "idperson_name": "9F53AE96144CB2F358C38BADE9E2F470CRM COM",
                "descriptionid": null"1",
                "alternative_codeemail": "CSR"null,
           },     "username": "MPAdministrator"
     "log_information":        }
   {     },
          "updatedudf_string_date2": "2015-03-16T14:32:25",
    null,
          "createdudf_bystring_unit3": null,
        "udf_string_4": null,
    {          "actual_completion_date": null,
         "communityudf_string_name5": "Main Community",
        udf_string_5",
          "groupprivacy_namelevel": "Main Group"null,
        "users_set": [],
         "nameudf_string_1": "Admin Unit"null,
          "accounts_receivable": null,
        "idlife_cycle_state": "48305F8849E3C18B227C5BE3A27BA6DFPENDING",
        "priority": 3,
         "descriptiontime_to_completion": "r1",{
            "time_period_uot": "WEEKS",
     "alternative_code": "MG"      "time_period_value": 3
        },
        "lost_reason": null,
        "createdcompetitors_dateset": "2015-03-16T14:32:14",[
            {
  "updated_by_unit":              "competitor": {
{                    "community_namewebsite": "Main CommunityZuora.com",
                    "group_name": "Main GroupZuora",
                    "namedescription": "Admin Unit",null,
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",0CC8A3BDCA7B41B78058D0A178390B06"
                },
                "descriptionid": "r1D6A0C981F18642D1B1DBAD040CD5CEE5",
            },
      "alternative_code": "MG"     {
          },      "competitor": {
        "created_by_user":            "website": null,
  {                    "person_name": "Marios LannisterMagnaQuest",
                    "usernamedescription": "mpadministrator"null,
                    "id": "1640A12797E964BFC99F8AF0EA538EEEA"
                },
                "updated_by_userid": "46DCBC25DBD846FFA3598C7B21264B41"
            },
    {        {
                "person_namecompetitor": "Marios{
Lannister",                    "usernamewebsite": "mpadministratorChargify.com",
                    "idname": "1Chargify",
               }     "description": null,
        },            "statusid": "02376768970343738D736979A1DE0C52"
                {},
                "nameid": "ReachC6AB17DC99214869A811611F51A54871",
            }
  "id": "5DA88E4C781244C2CDB0F4F57E2EE875",       ],
        "descriptiontime_overdue": null,{
               "alternative_code"time_period_uot": "RYEARS",
           },
  "time_period_value": 2.8657534246575342
         "importance": "IMPORTANCE2"},
           "life_cycle_state"category": "PENDING",{
            "typecode": "TA",
          {  "name": "TV Advert",
            "namedescription": "Software Purchase",
 null,
             "id": "F60FFE7AAD3F5B9B6E66A42266FA37C4614B3A5B38A942E6A74052C4F4606573",
         },
        "descriptionudf_string_6": null,
        "expected_completion_date": "2015-03-13T17:28:30",
        "alternativeudf_string_code7": "SP"null,
           },
 "udf_string_8": null,
         "descriptionstatus": null,{
            "contactalternative_emailcode": "webapi2@test.comRCH",
            "categoryname": "Reach",
          {  "description": null,
            "nameid": "Software PurchaseE9977550B9AA4DB78E08379B0F744E5A",

              "id"life_cycle_state": "C60F332D0B4CB8DD22A0159413951434PENDING",
        }
      "description": null},
    "status":  {
        "code": "SPOK",
           }"description": "",
           "lost_reason"message": null
  ""
    }
}

Versions Compared

Old Version 7

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Restrictions

Response Data

Examples

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

Restrictions

Response Data

Examples

Page Comparison

Versions Compared

Old Version 7

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Restrictions

Response Data

Examples

Anchorlead_create referred objects parameterslead_create referred objects parametersReferred Parameter Objects Data

Restrictions

Response Data

Examples

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