Emails.create - PipelinerCRM

Creates new Email

Request

Query Params

validation-level

integer <int32>

optional

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.

Body Params application / json

additional_headers

object

optional

Field containing json.

body

string

optional

Html text input field.

Example:

string

body_summary

string

optional

Multi-line text input field.

Example:

string

optional

Multi-line text input field.

Example:

string

company_email_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

content_share_mode

enum<integer>

optional

Integer enum value: 0 - Custom, 1 - Private, 2 - Public

Allowed values:

012

Example:

content_type

string

optional

Simple text input field.

Example:

string

date_sent

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

direction

enum<integer>

required

Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail

Allowed values:

Example:

error_code

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

is_tracked

boolean

optional

Boolean value.

Example:

false

original_id

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

owner_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

parent_email_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sender

string

optional

Multi-line text input field.

Example:

string

sender_account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sender_client_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sender_contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sentiment

enum<integer>

optional

Integer enum value: 0 - Negative, 1 - Neutral, 2 - Positive

Allowed values:

012

Example:

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

subject

string

optional

Name of the entity and its default text representation.

Example:

string

template_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

thread_id

string <uuid>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

01234567-abcd-dcba-ffff-000000000000

string

optional

Multi-line text input field.

Example:

string

type

enum<integer>

optional

Integer enum value: 1 - Standard, 2 - Mass

Allowed values:

Example:

uid

string

required

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

sharing_units

array [object {1}]

optional

Relations to SalesUnits.

string <uri>

optional

sharing_clients

array [object {1}]

optional

Relations to Clients.

string <uri>

optional

content_sharing_units

array [object {1}]

optional

Relations to SalesUnits.

string <uri>

optional

content_sharing_clients

array [object {1}]

optional

Relations to Clients.

string <uri>

optional

account_relations

array [object {1}]

optional

Relations to Accounts.

string <uri>

optional

contact_relations

array [object {1}]

optional

Relations to Contacts.

string <uri>

optional

project_relations

array [object {1}]

optional

Relations to Projects.

string <uri>

optional

custom_entity_relations

array [object {1}]

optional

Relations to CustomEntitys.

string <uri>

optional

lead_relations

array [object {1}]

optional

Relations to Leads.

string <uri>

optional

opportunity_relations

array [object {1}]

optional

Relations to Opportunitys.

string <uri>

optional

quote_relations

array [object {1}]

optional

Relations to Quotes.

string <uri>

optional

tags

array [object {1}]

optional

Relations to Tags.

string <uri>

optional

documents

array [object {1}]

optional

Relations to CloudObjects.

string <uri>

optional

Example

{
  "additional_headers": {},
  "body": "string",
  "body_summary": "string",
  "cc": "string",
  "company_email_id": "01234567-abcd-dcba-ffff-000000000000",
  "content_share_mode": 0,
  "content_type": "string",
  "date_sent": "2019-01-01T00:00:00",
  "direction": 1,
  "error_code": 1,
  "is_tracked": false,
  "original_id": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "parent_email_id": "01234567-abcd-dcba-ffff-000000000000",
  "sender": "string",
  "sender_account_id": "01234567-abcd-dcba-ffff-000000000000",
  "sender_client_id": "01234567-abcd-dcba-ffff-000000000000",
  "sender_contact_id": "01234567-abcd-dcba-ffff-000000000000",
  "sentiment": 0,
  "share_mode": 0,
  "subject": "string",
  "template_id": "01234567-abcd-dcba-ffff-000000000000",
  "thread_id": "01234567-abcd-dcba-ffff-000000000000",
  "to": "string",
  "type": 1,
  "uid": "string",
  "revision": 1,
  "sharing_units": [
    {
      "id": "http://example.com"
    }
  ],
  "sharing_clients": [
    {
      "id": "http://example.com"
    }
  ],
  "content_sharing_units": [
    {
      "id": "http://example.com"
    }
  ],
  "content_sharing_clients": [
    {
      "id": "http://example.com"
    }
  ],
  "account_relations": [
    {
      "id": "http://example.com"
    }
  ],
  "contact_relations": [
    {
      "id": "http://example.com"
    }
  ],
  "project_relations": [
    {
      "id": "http://example.com"
    }
  ],
  "custom_entity_relations": [
    {
      "id": "http://example.com"
    }
  ],
  "lead_relations": [
    {
      "id": "http://example.com"
    }
  ],
  "opportunity_relations": [
    {
      "id": "http://example.com"
    }
  ],
  "quote_relations": [
    {
      "id": "http://example.com"
    }
  ],
  "tags": [
    {
      "id": "http://example.com"
    }
  ],
  "documents": [
    {
      "id": "http://example.com"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/entities/Emails' \
--header 'Content-Type: application / json' \
--data-raw '{
    "additional_headers": {},
    "body": "string",
    "body_summary": "string",
    "cc": "string",
    "company_email_id": "01234567-abcd-dcba-ffff-000000000000",
    "content_share_mode": 0,
    "content_type": "string",
    "date_sent": "2019-01-01T00:00:00",
    "direction": 1,
    "error_code": 1,
    "is_tracked": false,
    "original_id": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_email_id": "01234567-abcd-dcba-ffff-000000000000",
    "sender": "string",
    "sender_account_id": "01234567-abcd-dcba-ffff-000000000000",
    "sender_client_id": "01234567-abcd-dcba-ffff-000000000000",
    "sender_contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "sentiment": 0,
    "share_mode": 0,
    "subject": "string",
    "template_id": "01234567-abcd-dcba-ffff-000000000000",
    "thread_id": "01234567-abcd-dcba-ffff-000000000000",
    "to": "string",
    "type": 1,
    "uid": "string",
    "revision": 1,
    "sharing_units": [
        {
            "id": "http://example.com"
        }
    ],
    "sharing_clients": [
        {
            "id": "http://example.com"
        }
    ],
    "content_sharing_units": [
        {
            "id": "http://example.com"
        }
    ],
    "content_sharing_clients": [
        {
            "id": "http://example.com"
        }
    ],
    "account_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "contact_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "project_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "custom_entity_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "lead_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "opportunity_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "quote_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "tags": [
        {
            "id": "http://example.com"
        }
    ],
    "documents": [
        {
            "id": "http://example.com"
        }
    ]
}'

Responses

🟢201Created

application/json

Creation confirmation. Returns created Email

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Email)

optional

is_delete_protected

boolean

read-onlyrequired

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.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

company_email

string <uri>

optional

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

string <uri>

optional

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

string <uri>

optional

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

string <uri>

optional

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

string <uri>

optional

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

string <uri>

optional

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

string <uri>

optional

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

object

optional

Field containing json.

body

string

optional

Html text input field.

Example:

string

body_summary

string

optional

Multi-line text input field.

Example:

string

optional

Multi-line text input field.

Example:

string

company_email_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

content_share_mode

enum<integer>

optional

Integer enum value: 0 - Custom, 1 - Private, 2 - Public

Allowed values:

012

Example:

content_type

string

optional

Simple text input field.

Example:

string

date_sent

string <date-time>

optional

Datetime information.

Example:

2019-01-01T00:00:00

direction

enum<integer>

required

Integer enum value: 1 - OutgoingEmail, 2 - IncomingEmail

Allowed values:

Example:

error_code

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

is_tracked

boolean

optional

Boolean value.

Example:

false

original_id

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

owner_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

parent_email_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sender

string

optional

Multi-line text input field.

Example:

string

sender_account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sender_client_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sender_contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

sentiment

enum<integer>

optional

Integer enum value: 0 - Negative, 1 - Neutral, 2 - Positive

Allowed values:

012

Example:

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

subject

string

optional

Name of the entity and its default text representation.

Example:

string

table_name

string

read-onlyrequired

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

template_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

thread_id

string <uuid>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

01234567-abcd-dcba-ffff-000000000000

string

optional

Multi-line text input field.

Example:

string

type

enum<integer>

optional

Integer enum value: 1 - Standard, 2 - Mass

Allowed values:

Example:

uid

string

required

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

sharing_units

array[string <uri>]

optional

Relations to SalesUnits.

sharing_clients

array[string <uri>]

optional

Relations to Clients.

content_sharing_units

array[string <uri>]

optional

Relations to SalesUnits.

content_sharing_clients

array[string <uri>]

optional

Relations to Clients.

account_relations

array[string <uri>]

optional

Relations to Accounts.

contact_relations

array[string <uri>]

optional

Relations to Contacts.

project_relations

array[string <uri>]

optional

Relations to Projects.

custom_entity_relations

array[string <uri>]

optional

Relations to CustomEntitys.

lead_relations

array[string <uri>]

optional

Relations to Leads.

opportunity_relations

array[string <uri>]

optional

Relations to Opportunitys.

quote_relations

array[string <uri>]

optional

Relations to Quotes.