Versions Compared

Old Version 12

changes.mady.by.user p_demou (Deactivated)

Saved on

compared with

New Version 13

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

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)

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:accounts_receivable_identifier
v4:accounts_receivable_identifier

description

(optional)

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

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

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

...

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": "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
titleExample 2
HTTP Method: POST
 

Request:  {{server}}/crmapi/rest/v2/leads/create
Body:
 Code Block
languagejs
{
     "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
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-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",
                "description": "admin unit",
                "id": "1"
            },
            "user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            }
        },
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "actual_completion_date": null,
        "udf_string_5": "udf_string_5",
        "privacy_level": null,
        "users_set": [],
        "udf_string_1": null,
        "accounts_receivable": null,
        "life_cycle_state": "IN_PROGRESS",
        "priority": 3,
        "time_to_completion": {
            "time_period_uot": "WEEKS",
            "time_period_value": 3
        },
        "lost_reason": null,
        "competitors_set": [],
        "time_overdue": {
            "time_period_uot": null,
            "time_period_value": null
        },
        "category": {
            "code": "NC",
            "name": "New Customer",
            "description": null,
            "id": "35EB799C52F14A8984FE2F397A852A78"
        },
        "udf_string_6": null,
        "expected_completion_date": "2018-02-12T17:28:30",
        "udf_string_7": null,
        "udf_string_8": null,
        "status": {
            "alternative_code": "LRN",
            "name": "Learn",
            "description": null,
            "id": "3602BCD537E94C1C925090F97F3A57FD",
            "life_cycle_state": "IN_PROGRESS"
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

...
 Expand
titleExample 3
HTTP Method: POST
 

Request:  {{server}}/crmapi/rest/v2/leads/create
Body:
 Code Block
languagejs
{
     "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,
    "source":{
        "type":"OTHER",
        "name":"test"
    
    },
    "importance" : "IMPORTANCE2",
    "priority" : 3,
    "type_identifier" : { "name" : "3-Play Mall Campaign"},
    "target_amount" : 58,
    "status_identifier" : { "name" : "Reach"},
    "category_identifier" : { "name" : "TV Advert"},
    "owned_by_group_identifier" : { "name" : "Main 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"}
        }
}
  
 

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-22T12:50:37",
            "updated_date": "2018-01-22T12:51:02",
            "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": "BP",
                "name": "Bronze Package",
                "description": null,
                "id": "B9EEF5A97F9F4BE690470CDB3FDA1B8C",
                "classification": "PACKAGE"
            }
        },
        "lead_source": {
            "name": "test",
            "type": "OTHER"
        },
        "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": "E450408A11E543028A148AE9926AABD4",
            "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": "TPMC",
            "name": "3-Play Mall Campaign",
            "description": null,
            "id": "2783ED2B25B242A78D450A10818FD54F"
        },
        "udf_date_2": null,
        "udf_date_1": null,
        "products_set": [
            {
                "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": "88D30AC2ABE34B769931FB530E9A8277",
                "product_brand": null
            },
            {
                "product_family": null,
                "product": null,
                "product_type": null,
                "id": "095EBB9EC3FF42B8B48623BC5DA1BA47",
                "product_brand": {
                    "alternative_code": "CS",
                    "name": "Corso Shoes",
                    "description": null,
                    "id": "5A917782ACA648B3BEAF417D1E64C43F"
                }
            },
            {
                "product_family": null,
                "product": {
                    "code": "Add On Product",
                    "product_type": {
                        "meter_reading_type": null,
                        "service_type": "TERMED",
                        "used_for_provisioning": true,
                        "alternative_code": "AO",
                        "udr_type": null,
                        "composition_method": "FLAT",
                        "name": "Add-ons",
                        "description": "Additional products",
                        "id": "E2324486B2454B56B054ED8129E3A9C0",
                        "classification": "SERVICES",
                        "physical_good_type": null
                    },
                    "alternative_code": "AOP",
                    "description": "Add On Product of type Add-ons",
                    "id": "2D95D67DB9CA438E93CAD054698AC17F",
                    "priority_level": null
                },
                "product_type": null,
                "id": "7F3A8CDF17574321AD47EAEBC1DD3F46",
                "product_brand": null
            },
            {
                "product_family": null,
                "product": {
                    "code": "Abstract Physical Good",
                    "product_type": {
                        "meter_reading_type": null,
                        "service_type": null,
                        "used_for_provisioning": true,
                        "alternative_code": "Physical Good",
                        "udr_type": null,
                        "composition_method": "FLAT",
                        "name": "Physical Good",
                        "description": null,
                        "id": "5B6DAF4AD7C94C4D9C3B49950E10B256",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "TRACEABLE"
                    },
                    "alternative_code": "APG",
                    "description": "Abstract Physical Good",
                    "id": "754BEFEB2C324667A869808E1E7A350F",
                    "priority_level": null
                },
                "product_type": null,
                "id": "9BFDFB209BB645EC99690ED58486C9D8",
                "product_brand": null
            }
        ],
        "udf_date_4": null,
        "contact_email": "webapi@test.com",
        "udf_date_3": null,
        "number": "132",
        "udf_float_3": null,
        "udf_float_4": null,
        "estimated_completion_time": {
            "time_period_uot": "WEEKS",
            "time_period_value": 3
        },
        "probability_to_win": 58,
        "id": "5D4919E5C6F54F27ABC37AECFA5FE8AC",
        "udf_float_1": null,
        "udf_float_2": null,
        "start_date": "2015-02-20T17:28:30",
        "assigned_to": {
            "unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": null,
                "username": "MPAdministrator"
            }
        },
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "actual_completion_date": null,
        "udf_string_5": "udf_string_5",
        "privacy_level": null,
        "users_set": [],
        "udf_string_1": null,
        "accounts_receivable": null,
        "life_cycle_state": "PENDING",
        "priority": 3,
        "time_to_completion": {
            "time_period_uot": "WEEKS",
            "time_period_value": 3
        },
        "lost_reason": null,
        "competitors_set": [
            {
                "competitor": {
                    "website": "Zuora.com",
                    "name": "Zuora",
                    "description": null,
                    "id": "0CC8A3BDCA7B41B78058D0A178390B06"
                },
                "id": "D6A0C981F18642D1B1DBAD040CD5CEE5"
            },
            {
                "competitor": {
                    "website": null,
                    "name": "MagnaQuest",
                    "description": null,
                    "id": "640A12797E964BFC99F8AF0EA538EEEA"
                },
                "id": "46DCBC25DBD846FFA3598C7B21264B41"
            },
            {
                "competitor": {
                    "website": "Chargify.com",
                    "name": "Chargify",
                    "description": null,
                    "id": "02376768970343738D736979A1DE0C52"
                },
                "id": "C6AB17DC99214869A811611F51A54871"
            }
        ],
        "time_overdue": {
            "time_period_uot": "YEARS",
            "time_period_value": 2.8657534246575342
        },
        "category": {
            "code": "TA",
            "name": "TV Advert",
            "description": null,
            "id": "614B3A5B38A942E6A74052C4F4606573"
        },
        "udf_string_6": null,
        "expected_completion_date": "2015-03-13T17:28:30",
        "udf_string_7": null,
        "udf_string_8": null,
        "status": {
            "alternative_code": "RCH",
            "name": "Reach",
            "description": null,
            "id": "E9977550B9AA4DB78E08379B0F744E5A",
            "life_cycle_state": "PENDING"
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

...