Emails.update - PipelinerCRM

Modifies Email or Emails with given id(s)

Request

Path Params

Query Params

Body Params application/jsonRequired

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",
    "schedule_settings": {},
    "send_at": "2019-01-01T00:00:00",
    "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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/entities/Emails/?validation-level' \
--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",
    "schedule_settings": {},
    "send_at": "2019-01-01T00:00:00",
    "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

🟢200OK

application/json

Modification confirmation. Returns resulting Email

Body

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "company_email": "http://example.com",
        "owner": "http://example.com",
        "parent_email": "http://example.com",
        "sender_account": "http://example.com",
        "sender_client": "http://example.com",
        "sender_contact": "http://example.com",
        "template": "http://example.com",
        "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",
        "schedule_settings": {},
        "send_at": "2019-01-01T00:00:00",
        "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",
        "table_name": "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": [
            "http://example.com"
        ],
        "sharing_clients": [
            "http://example.com"
        ],
        "content_sharing_units": [
            "http://example.com"
        ],
        "content_sharing_clients": [
            "http://example.com"
        ],
        "account_relations": [
            "http://example.com"
        ],
        "contact_relations": [
            "http://example.com"
        ],
        "project_relations": [
            "http://example.com"
        ],
        "custom_entity_relations": [
            "http://example.com"
        ],
        "lead_relations": [
            "http://example.com"
        ],
        "opportunity_relations": [
            "http://example.com"
        ],
        "quote_relations": [
            "http://example.com"
        ],
        "tags": [
            "http://example.com"
        ],
        "documents": [
            "http://example.com"
        ]
    }
}

🟠404Not Found

🔴500Internal Server Error