TagRelations.create - PipelinerCRM

Creates new TagRelation

Request

Query Params

validation-level

integer <int32>

optional

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

account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

lead_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

oppty_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

project_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

tag_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

{
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "email_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "process_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_id": "01234567-abcd-dcba-ffff-000000000000",
    "tag_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created TagRelation

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (TagRelation)

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

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.

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.

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.

lead

string <uri>

optional

Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties.

oppty

string <uri>

optional

Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.

process

string <uri>

optional

Relation to Process. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Process' object for properties.

project

string <uri>

optional

Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties.

tag

string <uri>

required

Relation to Tag. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Tag' object for properties.

account_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

lead_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

oppty_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

process_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

project_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

tag_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

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",
        "account": "http://example.com",
        "contact": "http://example.com",
        "email": "http://example.com",
        "lead": "http://example.com",
        "oppty": "http://example.com",
        "process": "http://example.com",
        "project": "http://example.com",
        "tag": "http://example.com",
        "account_id": "01234567-abcd-dcba-ffff-000000000000",
        "contact_id": "01234567-abcd-dcba-ffff-000000000000",
        "email_id": "01234567-abcd-dcba-ffff-000000000000",
        "lead_id": "01234567-abcd-dcba-ffff-000000000000",
        "oppty_id": "01234567-abcd-dcba-ffff-000000000000",
        "process_id": "01234567-abcd-dcba-ffff-000000000000",
        "project_id": "01234567-abcd-dcba-ffff-000000000000",
        "tag_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1
    }
}

🔴500Server Error