Back to PipelinerLeads.create
Input
type: object
properties:
parameters:
type: object
properties:
validation-level:
type: integer
format: int32
description: >-
Specify validation level of lead on create. Use them as bit mask: 0 -
validate each field on entity,
2 - validate only changed fields, 4 - validate only system fields, 8 -
allows to override readonly fields,
16 - allows to set entity on deleted relationship.
title: Parameters
data:
required:
- name
properties:
modified:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Last modification time.
readOnly: true
created:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Creation time.
description:
type: string
example: string
description: Multi-line text input field.
is_archived:
type: boolean
example: false
description: Boolean value.
label_flag:
type: string
example: 1
enum:
- 1
- 2
- 4
description: |-
Opportunity label flag.
Options:
Priority = 1 (0b001)
Hot = 2 (0b010)
Stalled = 4 (0b100)
lead_type_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
name:
type: string
example: string
description: Name of the entity and its default text representation.
owner_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
quick_account_email:
type: string
example: string
description: Simple text input field.
quick_account_name:
type: string
example: string
description: Simple text input field.
quick_account_phone:
type: string
example: string
description: Simple text input field.
quick_contact_name:
type: string
example: string
description: Simple text input field.
quick_email:
type: string
example: string
description: Simple text input field.
quick_phone:
type: string
example: string
description: Simple text input field.
ranking:
type: integer
format: int32
example: 1
description: Qualitative ranking of the opportunity.
reason_of_close_description:
type: string
example: string
description: Multi-line text input field.
reason_of_close_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
share_mode:
type: integer
description: >-
Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 -
AllEdit
example: 0
enum:
- 0
- 1
- 2
- 3
step_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
unit_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
contact_relations:
type: array
description: Relations to Contacts.
items:
type: object
description: >-
Relation to LeadOpptyContactRelation, see:
'createLeadOpptyContactRelationInput' object for properties.
properties:
id:
type: string
format: uri
account_relations:
type: array
description: Relations to Accounts.
items:
type: object
description: >-
Relation to LeadOpptyAccountRelation, see:
'createLeadOpptyAccountRelationInput' object for properties.
properties:
id:
type: string
format: uri
sharing_units:
type: array
description: Relations to SalesUnits.
items:
type: object
description: >-
Relation to LeadOpptySharingSalesUnitRelation, see:
'createLeadOpptySharingSalesUnitRelationInput' object for
properties.
properties:
id:
type: string
format: uri
sharing_clients:
type: array
description: Relations to Clients.
items:
type: object
description: >-
Relation to LeadOpptySharingClientRelation, see:
'createLeadOpptySharingClientRelationInput' object for properties.
properties:
id:
type: string
format: uri
documents:
type: array
description: Relations to CloudObjects.
items:
type: object
description: >-
Relation to CloudObjectRelation, see:
'createCloudObjectRelationInput' object for properties.
properties:
id:
type: string
format: uri
tags:
type: array
description: Relations to Tags.
items:
type: object
description: >-
Relation to TagRelation, see: 'createTagRelationInput' object for
properties.
properties:
id:
type: string
format: uri
lost_date:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: ''
type: object
title: Data
Output
type: object
properties:
success:
type: boolean
example: true
description: True when response succeeded, false on error.
data:
required:
- is_delete_protected
- id
- lead_type
- step
- unit
- name
- status
- days_in_step
- is_favorite
- formatted_name
properties:
is_delete_protected:
type: boolean
example: false
description: >-
Tells if the entity instance is protected against delete (Entities
that need to be present in the system at any time). Delete action
still may fail if entity is deletable, due some other additional
validations.
readOnly: true
id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Unique identifier of entity.
readOnly: true
is_deleted:
type: boolean
example: false
description: Specifies if the entity is considered deleted.
readOnly: true
modified:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Last modification time.
readOnly: true
created:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Creation time.
lead_type:
type: string
format: uri
description: >-
Relation to LeadType. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'LeadType' object for properties.
owner:
type: string
format: uri
description: >-
Relation to Client. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Client' object for properties.
reason_of_close:
type: string
format: uri
description: >-
Relation to Data. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Data' object for properties.
step:
type: string
format: uri
description: >-
Relation to Step. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Step' object for properties.
unit:
type: string
format: uri
description: >-
Relation to SalesUnit. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'SalesUnit' object for properties.
description:
type: string
example: string
description: Multi-line text input field.
is_archived:
type: boolean
example: false
description: Boolean value.
label_flag:
type: string
example: 1
enum:
- 1
- 2
- 4
description: |-
Opportunity label flag.
Options:
Priority = 1 (0b001)
Hot = 2 (0b010)
Stalled = 4 (0b100)
lead_type_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
name:
type: string
example: string
description: Name of the entity and its default text representation.
owner_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
quick_account_email:
type: string
example: string
description: Simple text input field.
quick_account_name:
type: string
example: string
description: Simple text input field.
quick_account_phone:
type: string
example: string
description: Simple text input field.
quick_contact_name:
type: string
example: string
description: Simple text input field.
quick_email:
type: string
example: string
description: Simple text input field.
quick_phone:
type: string
example: string
description: Simple text input field.
ranking:
type: integer
format: int32
example: 1
description: Qualitative ranking of the opportunity.
reason_of_close_description:
type: string
example: string
description: Multi-line text input field.
reason_of_close_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
share_mode:
type: integer
description: >-
Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 -
AllEdit
example: 0
enum:
- 0
- 1
- 2
- 3
step_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
unit_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
primary_contact:
type: string
format: uri
description: >-
Relation to Contact. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Contact' object for properties.
primary_account:
type: string
format: uri
description: >-
Relation to Account. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'Account' object for properties.
contact_relations:
type: array
description: Relations to Contacts.
items:
type: string
format: uri
description: >-
Relation to LeadOpptyContactRelation. By default it is returned as
URI to related resource. Using parameter 'expand', it will return
full entity. See: 'LeadOpptyContactRelation' object for properties.
account_relations:
type: array
description: Relations to Accounts.
items:
type: string
format: uri
description: >-
Relation to LeadOpptyAccountRelation. By default it is returned as
URI to related resource. Using parameter 'expand', it will return
full entity. See: 'LeadOpptyAccountRelation' object for properties.
status:
type: integer
description: 'Integer enum value: 1 - Open, 2 - Lost, 4 - Qualified'
example: 1
enum:
- 1
- 2
- 4
readOnly: true
sharing_units:
type: array
description: Relations to SalesUnits.
items:
type: string
format: uri
description: >-
Relation to LeadOpptySharingSalesUnitRelation. By default it is
returned as URI to related resource. Using parameter 'expand', it
will return full entity. See: 'LeadOpptySharingSalesUnitRelation'
object for properties.
sharing_clients:
type: array
description: Relations to Clients.
items:
type: string
format: uri
description: >-
Relation to LeadOpptySharingClientRelation. By default it is
returned as URI to related resource. Using parameter 'expand', it
will return full entity. See: 'LeadOpptySharingClientRelation'
object for properties.
documents:
type: array
description: Relations to CloudObjects.
items:
type: string
format: uri
description: >-
Relation to CloudObjectRelation. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'CloudObjectRelation' object for properties.
tags:
type: array
description: Relations to Tags.
items:
type: string
format: uri
description: >-
Relation to TagRelation. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'TagRelation' object for properties.
qualify_date:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: ''
days_in_step:
type: integer
format: int32
example: 1
description: ''
is_favorite:
type: boolean
example: false
description: ''
lost_date:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: ''
formatted_name:
type: string
example: string
description: ''
scoring:
type: object
description: ''
modified_by_user:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: ''
type: object