Back to PipelinerContacts.merge
Merger multiple Contacts into master record.
Input
type: object
properties:
data:
type: object
properties:
master:
properties:
created:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Creation time.
picture:
type: object
description: >-
Relation to CloudObject, see: 'updateCloudObjectInput' object for
properties.
properties:
id:
type: string
format: uri
address:
type: string
example: string
description: Multi-line text input field.
city:
type: string
example: string
description: Simple text input field.
comments:
type: string
example: string
description: Multi-line text input field.
contact_type_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
country:
type: string
example: string
description: >-
Generic field wrapping sqlalchemy column, configurable by
constructor.
Good for one-of fields / generated fields.
email1:
type: string
example: string
description: Email address.
email2:
type: string
example: string
description: Email address.
email3:
type: string
example: string
description: Email address.
email4:
type: string
example: string
description: Email address.
email5:
type: string
example: string
description: Email address.
first_name:
type: string
example: string
description: Simple text input field.
gender:
type: integer
description: >-
Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 -
NonBinary
example: 0
enum:
- 0
- 1
- 2
- 3
last_name:
type: string
example: string
description: Simple text input field.
middle_name:
type: string
example: string
description: Simple text input field.
owner_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
phone1:
type: string
example: string
description: Phone number.
phone2:
type: string
example: string
description: Phone number.
phone3:
type: string
example: string
description: Phone number.
phone4:
type: string
example: string
description: Phone number.
phone5:
type: string
example: string
description: Phone number.
picture_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
position:
type: string
example: string
description: Simple text input field.
quick_account_name:
type: string
example: string
description: Simple text input field.
share_mode:
type: integer
description: >-
Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 -
AllEdit
example: 0
enum:
- 0
- 1
- 2
- 3
state_province:
type: string
example: string
description: Simple text input field.
title:
type: string
example: string
description: Simple text input field.
unit_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
zip_code:
type: string
example: string
description: Simple text input field.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
social_media:
type: object
description: >-
Relation to ContactSocialRelation, see:
'updateContactSocialRelationInput' object for properties.
properties:
id:
type: string
format: uri
account_relations:
type: array
description: Relations to Accounts.
items:
type: object
description: >-
Relation to ContactAccountRelation, see:
'updateContactAccountRelationInput' object for properties.
properties:
id:
type: string
format: uri
sharing_units:
type: array
description: Relations to SalesUnits.
items:
type: object
description: >-
Relation to ContactSharingSalesUnitRelation, see:
'updateContactSharingSalesUnitRelationInput' object for
properties.
properties:
id:
type: string
format: uri
sharing_clients:
type: array
description: Relations to Clients.
items:
type: object
description: >-
Relation to ContactSharingClientRelation, see:
'updateContactSharingClientRelationInput' object for properties.
properties:
id:
type: string
format: uri
documents:
type: array
description: Relations to CloudObjects.
items:
type: object
description: >-
Relation to CloudObjectRelation, see:
'updateCloudObjectRelationInput' object for properties.
properties:
id:
type: string
format: uri
exchange_entity_id:
type: string
example: string
description: ''
gapi_entity_id:
type: string
example: string
description: ''
o365_entity_id:
type: string
example: string
description: ''
primary_account_account_roles:
type: array
description: Roles of Contact in his primary Account.
items:
type: object
description: >-
Relation to ContactAccountAccountRoleRelation, see:
'updateContactAccountAccountRoleRelationInput' object for
properties.
properties:
id:
type: string
format: uri
account_position:
type: string
example: string
description: >-
Job position of Contact in his primary Account or quick account
position if Contact has no primary Account.
is_unsubscribed:
type: boolean
example: false
description: If account has any unsubscribed email.
tags:
type: array
description: Relations to Tags.
items:
type: object
description: >-
Relation to TagRelation, see: 'updateTagRelationInput' object
for properties.
properties:
id:
type: string
format: uri
primary_account_relationship:
type: string
example: string
description: Org chart relationship of Contact in his primary Account.
id:
description: ID of object to update.
type: string
format: uuid
type: object
secondary_ids:
type: array
items:
type: string
description: An id of secondary contact.
format: uuid
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
- contact_type
- owner
- unit
- owner_id
- formatted_name
- is_favorite
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.
contact_type:
type: string
format: uri
description: >-
Relation to ContactType. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'ContactType' 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.
picture:
type: string
format: uri
description: >-
Relation to CloudObject. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'CloudObject' 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.
address:
type: string
example: string
description: Multi-line text input field.
city:
type: string
example: string
description: Simple text input field.
comments:
type: string
example: string
description: Multi-line text input field.
contact_type_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
country:
type: string
example: string
description: |-
Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
email1:
type: string
example: string
description: Email address.
email2:
type: string
example: string
description: Email address.
email3:
type: string
example: string
description: Email address.
email4:
type: string
example: string
description: Email address.
email5:
type: string
example: string
description: Email address.
first_name:
type: string
example: string
description: Simple text input field.
gender:
type: integer
description: 'Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary'
example: 0
enum:
- 0
- 1
- 2
- 3
last_name:
type: string
example: string
description: Simple text input field.
middle_name:
type: string
example: string
description: Simple text input field.
owner_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
phone1:
type: string
example: string
description: Phone number.
phone2:
type: string
example: string
description: Phone number.
phone3:
type: string
example: string
description: Phone number.
phone4:
type: string
example: string
description: Phone number.
phone5:
type: string
example: string
description: Phone number.
picture_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
position:
type: string
example: string
description: Simple text input field.
quick_account_name:
type: string
example: string
description: Simple text input field.
share_mode:
type: integer
description: >-
Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 -
AllEdit
example: 0
enum:
- 0
- 1
- 2
- 3
state_province:
type: string
example: string
description: Simple text input field.
title:
type: string
example: string
description: Simple text input field.
unit_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
zip_code:
type: string
example: string
description: Simple text input field.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
formatted_name:
type: string
example: string
description: ''
social_media:
type: string
format: uri
description: >-
Relation to ContactSocialRelation. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'ContactSocialRelation' 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.
account_relations:
type: array
description: Relations to Accounts.
items:
type: string
format: uri
description: >-
Relation to ContactAccountRelation. By default it is returned as URI
to related resource. Using parameter 'expand', it will return full
entity. See: 'ContactAccountRelation' object for properties.
sharing_units:
type: array
description: Relations to SalesUnits.
items:
type: string
format: uri
description: >-
Relation to ContactSharingSalesUnitRelation. By default it is
returned as URI to related resource. Using parameter 'expand', it
will return full entity. See: 'ContactSharingSalesUnitRelation'
object for properties.
sharing_clients:
type: array
description: Relations to Clients.
items:
type: string
format: uri
description: >-
Relation to ContactSharingClientRelation. By default it is returned
as URI to related resource. Using parameter 'expand', it will return
full entity. See: 'ContactSharingClientRelation' 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.
is_favorite:
type: boolean
example: false
description: ''
primary_account_account_roles:
type: array
description: Roles of Contact in his primary Account.
items:
type: string
format: uri
description: >-
Relation to ContactAccountAccountRoleRelation. By default it is
returned as URI to related resource. Using parameter 'expand', it
will return full entity. See: 'ContactAccountAccountRoleRelation'
object for properties.
primary_account_position:
type: string
example: string
description: Job position of Contact in his primary Account.
account_position:
type: string
example: string
description: >-
Job position of Contact in his primary Account or quick account
position if Contact has no primary Account.
is_unsubscribed:
type: boolean
example: false
description: If account has any unsubscribed email.
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.
primary_account_relationship:
type: string
example: string
description: Org chart relationship of Contact in his primary Account.
modified_by_user:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: ''
type: object