Back to PipelinerEmailSequences.update
Modifies emailsequence or EmailSequences with given id(s)
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: string
format: uuid
description: ID of emailsequence to update
validation-level:
type: integer
format: int32
description: >-
Specify validation level of emailsequence 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:
description:
type: string
example: string
description: Multi-line text input field.
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.
settings:
type: object
description: Form definition in json format.
type:
type: integer
description: 'Integer enum value: 1 - Personal, 2 - Space'
example: 1
enum:
- 1
- 2
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
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
- owner
- name
- owner_id
- type
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
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.
deactivation_reason:
type: integer
description: >-
Integer enum value: 0 - NoReason, 1 - Manual, 2 - TooManyErrors, 3 -
DisabledFeature
example: 0
enum:
- 0
- 1
- 2
- 3
description:
type: string
example: string
description: Multi-line text input field.
is_enabled:
type: boolean
example: false
description: Boolean value.
last_schema_change:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Datetime information.
last_status_change:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Datetime information.
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.
settings:
type: object
description: Form definition in json format.
type:
type: integer
description: 'Integer enum value: 1 - Personal, 2 - Space'
example: 1
enum:
- 1
- 2
activity_logs:
type: array
description: Relations to EmailSequenceActivityLogs.
items:
type: string
format: uri
description: >-
Relation to EmailSequenceActivityLog. By default it is returned as
URI to related resource. Using parameter 'expand', it will return
full entity. See: 'EmailSequenceActivityLog' 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.
enrolled:
type: array
description: Relations to EmailSequenceEnrolleds.
items:
type: string
format: uri
description: >-
Relation to EmailSequenceEnrolled. By default it is returned as URI
to related resource. Using parameter 'expand', it will return full
entity. See: 'EmailSequenceEnrolled' object for properties.
type: object