Back to PipelinerClients.update
Modifies client or Clients with given id(s)
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: string
format: uuid
description: ID of client to update
validation-level:
type: integer
format: int32
description: >-
Specify validation level of client on update. 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.
required:
- id
title: Parameters
data:
properties:
default_unit_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
master_right_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.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
unit_membership:
type: array
description: Relations to SalesUnits.
items:
type: object
description: >-
Relation to SalesUnitClientRelation, see:
'updateSalesUnitClientRelationInput' object for properties.
properties:
id:
type: string
format: uri
appointment_favorite:
type: array
description: Relations to Appointments.
items:
type: object
description: >-
Relation to ClientFavorite, see: 'updateClientFavoriteInput' object
for properties.
properties:
id:
type: string
format: uri
task_favorite:
type: array
description: Relations to Tasks.
items:
type: object
description: >-
Relation to ClientFavorite, see: 'updateClientFavoriteInput' object
for properties.
properties:
id:
type: string
format: uri
account_favorite:
type: array
description: Relations to Accounts.
items:
type: object
description: >-
Relation to ClientFavorite, see: 'updateClientFavoriteInput' object
for properties.
properties:
id:
type: string
format: uri
contact_favorite:
type: array
description: Relations to Contacts.
items:
type: object
description: >-
Relation to ClientFavorite, see: 'updateClientFavoriteInput' object
for properties.
properties:
id:
type: string
format: uri
profile_favorite:
type: array
description: Relations to Profiles.
items:
type: object
description: >-
Relation to ClientFavorite, see: 'updateClientFavoriteInput' object
for properties.
properties:
id:
type: string
format: uri
report_favorite:
type: array
description: Relations to Reports.
items:
type: object
description: >-
Relation to ClientFavorite, see: 'updateClientFavoriteInput' object
for properties.
properties:
id:
type: string
format: uri
lead_favorite:
type: array
description: Relations to Leads.
items:
type: object
description: >-
Relation to ClientFavorite, see: 'updateClientFavoriteInput' object
for properties.
properties:
id:
type: string
format: uri
opportunity_favorite:
type: array
description: Relations to Opportunitys.
items:
type: object
description: >-
Relation to ClientFavorite, see: 'updateClientFavoriteInput' object
for properties.
properties:
id:
type: string
format: uri
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
- default_unit
- master_right
- default_unit_id
- email
- master_right_id
- unit_membership
- formatted_name
- unit_manager_ids
- unit_member_ids
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.
readOnly: true
default_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.
master_right:
type: string
format: uri
description: >-
Relation to MasterRight. By default it is returned as URI to related
resource. Using parameter 'expand', it will return full entity. See:
'MasterRight' object for properties.
default_unit_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
email:
type: string
example: string
description: Email. Readonly information from UserProfile.
first_name:
type: string
example: string
description: First name. Readonly information from UserProfile.
readOnly: true
last_active:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Datetime information.
readOnly: true
last_name:
type: string
example: string
description: Last name. Readonly information from UserProfile.
readOnly: true
master_right_id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Relation to single entity instance.
middle_name:
type: string
example: string
description: Middle name. Readonly information from UserProfile.
readOnly: true
phone:
type: string
example: string
description: Phone number. Readonly information from UserProfile.
readOnly: true
picture_url:
type: string
example: string
description: Picture name. Readonly information from UserProfile.
readOnly: true
position:
type: string
example: string
description: Simple text input field.
region:
type: string
example: string
description: Region. Readonly information from UserProfile.
readOnly: true
timezone:
type: string
example: string
description: Timezone offset (DEPRECATED)Readonly information from UserProfile.
readOnly: true
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
default_idp:
type: integer
format: int32
example: 1
description: default_idp retrieved from user, if enabled [HEAVY]
unit_membership:
type: array
description: Relations to SalesUnits.
items:
type: string
format: uri
description: >-
Relation to SalesUnitClientRelation. By default it is returned as
URI to related resource. Using parameter 'expand', it will return
full entity. See: 'SalesUnitClientRelation' object for properties.
appointment_favorite:
type: array
description: Relations to Appointments.
items:
type: string
format: uri
description: >-
Relation to ClientFavorite. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'ClientFavorite' object for properties.
task_favorite:
type: array
description: Relations to Tasks.
items:
type: string
format: uri
description: >-
Relation to ClientFavorite. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'ClientFavorite' object for properties.
account_favorite:
type: array
description: Relations to Accounts.
items:
type: string
format: uri
description: >-
Relation to ClientFavorite. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'ClientFavorite' object for properties.
contact_favorite:
type: array
description: Relations to Contacts.
items:
type: string
format: uri
description: >-
Relation to ClientFavorite. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'ClientFavorite' object for properties.
profile_favorite:
type: array
description: Relations to Profiles.
items:
type: string
format: uri
description: >-
Relation to ClientFavorite. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'ClientFavorite' object for properties.
report_favorite:
type: array
description: Relations to Reports.
items:
type: string
format: uri
description: >-
Relation to ClientFavorite. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'ClientFavorite' object for properties.
lead_favorite:
type: array
description: Relations to Leads.
items:
type: string
format: uri
description: >-
Relation to ClientFavorite. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'ClientFavorite' object for properties.
opportunity_favorite:
type: array
description: Relations to Opportunitys.
items:
type: string
format: uri
description: >-
Relation to ClientFavorite. By default it is returned as URI to
related resource. Using parameter 'expand', it will return full
entity. See: 'ClientFavorite' object for properties.
timezone_name:
type: string
example: string
description: IANA timezone name from UserProfile
name:
type: string
example: string
description: ''
formatted_name:
type: string
example: string
description: ''
unit_manager_ids:
type: array
description: ''
items:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
unit_member_ids:
type: array
description: ''
items:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
type: object