Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

Emails.create

Creates new email

Input

type: object properties: parameters: type: object properties: validation-level: type: integer format: int32 description: >- Specify validation level of email 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: - direction - uid 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. readOnly: true additional_headers: type: object description: Field containing json. body: type: string example: string description: Html text input field. body_summary: type: string example: string description: Multi-line text input field. cc: type: string example: string description: Multi-line text input field. company_email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. content_share_mode: type: integer description: 'Integer enum value: 0 - Custom, 1 - Private, 2 - Public' example: 0 enum: - 0 - 1 - 2 content_type: type: string example: string description: Simple text input field. date_sent: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: Datetime information. direction: type: integer description: 'Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' example: 1 enum: - 1 - 2 error_code: type: integer format: int32 example: 1 description: |- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. is_tracked: type: boolean example: false description: Boolean value. original_id: type: string example: string description: |- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. parent_email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. sender: type: string example: string description: Multi-line text input field. sender_account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. sender_client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. sender_contact_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 subject: type: string example: string description: Name of the entity and its default text representation. template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. thread_id: type: string example: string description: |- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. to: type: string example: string description: Multi-line text input field. type: type: integer description: 'Integer enum value: 1 - Standard, 2 - Mass' example: 1 enum: - 1 - 2 uid: type: string example: string description: |- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sharing_units: type: array description: Relations to SalesUnits. items: type: object description: >- Relation to MessageSharingSalesUnitRelation, see: 'createMessageSharingSalesUnitRelationInput' object for properties. properties: id: type: string format: uri sharing_clients: type: array description: Relations to Clients. items: type: object description: >- Relation to MessageSharingClientRelation, see: 'createMessageSharingClientRelationInput' object for properties. properties: id: type: string format: uri content_sharing_units: type: array description: Relations to SalesUnits. items: type: object description: >- Relation to EmailContentSharingSalesUnitRelation, see: 'createEmailContentSharingSalesUnitRelationInput' object for properties. properties: id: type: string format: uri content_sharing_clients: type: array description: Relations to Clients. items: type: object description: >- Relation to EmailContentSharingClientRelation, see: 'createEmailContentSharingClientRelationInput' object for properties. properties: id: type: string format: uri account_relations: type: array description: Relations to Accounts. items: type: object description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. properties: id: type: string format: uri contact_relations: type: array description: Relations to Contacts. items: type: object description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. properties: id: type: string format: uri project_relations: type: array description: Relations to Projects. items: type: object description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. properties: id: type: string format: uri lead_relations: type: array description: Relations to Leads. items: type: object description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. properties: id: type: string format: uri opportunity_relations: type: array description: Relations to Opportunitys. items: type: object description: >- Relation to MessageRelation, see: 'createMessageRelationInput' object for properties. properties: id: type: string format: uri quote_relations: type: array description: Relations to Quotes. items: type: object description: >- Relation to MessageRelation, see: 'createMessageRelationInput' 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 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 - direction - uid 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 company_email: type: string format: uri description: >- Relation to CompanyEmail. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CompanyEmail' 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. parent_email: type: string format: uri description: >- Relation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties. sender_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. sender_client: 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. sender_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. template: type: string format: uri description: >- Relation to EmailTemplate. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailTemplate' object for properties. additional_headers: type: object description: Field containing json. body: type: string example: string description: Html text input field. body_summary: type: string example: string description: Multi-line text input field. cc: type: string example: string description: Multi-line text input field. company_email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. content_share_mode: type: integer description: 'Integer enum value: 0 - Custom, 1 - Private, 2 - Public' example: 0 enum: - 0 - 1 - 2 content_type: type: string example: string description: Simple text input field. date_sent: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: Datetime information. direction: type: integer description: 'Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail' example: 1 enum: - 1 - 2 error_code: type: integer format: int32 example: 1 description: |- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. is_tracked: type: boolean example: false description: Boolean value. original_id: type: string example: string description: |- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. parent_email_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. sender: type: string example: string description: Multi-line text input field. sender_account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. sender_client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. sender_contact_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 subject: type: string example: string description: Name of the entity and its default text representation. template_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. thread_id: type: string example: string description: |- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. to: type: string example: string description: Multi-line text input field. type: type: integer description: 'Integer enum value: 1 - Standard, 2 - Mass' example: 1 enum: - 1 - 2 uid: type: string example: string description: |- Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. sharing_units: type: array description: Relations to SalesUnits. items: type: string format: uri description: >- Relation to MessageSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageSharingSalesUnitRelation' object for properties. sharing_clients: type: array description: Relations to Clients. items: type: string format: uri description: >- Relation to MessageSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageSharingClientRelation' object for properties. content_sharing_units: type: array description: Relations to SalesUnits. items: type: string format: uri description: >- Relation to EmailContentSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailContentSharingSalesUnitRelation' object for properties. content_sharing_clients: type: array description: Relations to Clients. items: type: string format: uri description: >- Relation to EmailContentSharingClientRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'EmailContentSharingClientRelation' object for properties. account_relations: type: array description: Relations to Accounts. items: type: string format: uri description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. contact_relations: type: array description: Relations to Contacts. items: type: string format: uri description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. project_relations: type: array description: Relations to Projects. items: type: string format: uri description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. lead_relations: type: array description: Relations to Leads. items: type: string format: uri description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. opportunity_relations: type: array description: Relations to Opportunitys. items: type: string format: uri description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' object for properties. quote_relations: type: array description: Relations to Quotes. items: type: string format: uri description: >- Relation to MessageRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MessageRelation' 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. type: object