Memos.create - PipelinerCRM

Creates new Memo

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of Memo 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

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

subject

string

required

Name of the entity and its default text representation.

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

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

lead_relations

array [object {1}]

optional

Relations to Leads.

string <uri>

optional

quote_relations

array [object {1}]

optional

Relations to Quotes.

string <uri>

optional

opportunity_relations

array [object {1}]

optional

Relations to Opportunitys.

string <uri>

optional

custom_entity_relations

array [object {1}]

optional

Relations to CustomEntitys.

string <uri>

optional

documents

array [object {1}]

optional

Relations to CloudObjects.

string <uri>

optional

comments

array [object {1}]

optional

Relations to MemoComments.

string <uri>

optional

Example

{
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "subject": "string",
    "revision": 1,
    "sharing_units": [
        {
            "id": "http://example.com"
        }
    ],
    "sharing_clients": [
        {
            "id": "http://example.com"
        }
    ],
    "account_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "contact_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "project_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "lead_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "quote_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "opportunity_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "custom_entity_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "documents": [
        {
            "id": "http://example.com"
        }
    ],
    "comments": [
        {
            "id": "http://example.com"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created Memo

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Memo)

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

owner

string <uri>

required

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.

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

subject

string

required

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

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.

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.

lead_relations

array[string <uri>]

optional

Relations to Leads.

quote_relations

array[string <uri>]

optional

Relations to Quotes.

opportunity_relations

array[string <uri>]

optional

Relations to Opportunitys.

custom_entity_relations

array[string <uri>]

optional

Relations to CustomEntitys.

documents

array[string <uri>]

optional

Relations to CloudObjects.

comments

array[string <uri>]

optional

Relations to MemoComments.

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",
        "owner": "http://example.com",
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "subject": "string",
        "table_name": "string",
        "revision": 1,
        "sharing_units": [
            "http://example.com"
        ],
        "sharing_clients": [
            "http://example.com"
        ],
        "account_relations": [
            "http://example.com"
        ],
        "contact_relations": [
            "http://example.com"
        ],
        "project_relations": [
            "http://example.com"
        ],
        "lead_relations": [
            "http://example.com"
        ],
        "quote_relations": [
            "http://example.com"
        ],
        "opportunity_relations": [
            "http://example.com"
        ],
        "custom_entity_relations": [
            "http://example.com"
        ],
        "documents": [
            "http://example.com"
        ],
        "comments": [
            "http://example.com"
        ]
    }
}

🔴500Server Error