ContactRelationLabels.create

Creates new ContactRelationLabel

Request

Query Params

validation-level

integer <int32>

optional

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

contact_relation

object

required

Relation to ContactRelation, see: 'createContactRelationInput' object for properties.

string <uri>

optional

contact_relation_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_relation_type_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

{
    "contact_relation": {
        "id": "http://example.com"
    },
    "contact_relation_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_relation_type_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 ContactRelationLabel

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (ContactRelationLabel)

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

contact_relation

string <uri>

required

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

contact_relation_type

string <uri>

required

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

contact_relation_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

contact_relation_type_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",
        "contact_relation": "http://example.com",
        "contact_relation_type": "http://example.com",
        "contact_relation_id": "01234567-abcd-dcba-ffff-000000000000",
        "contact_relation_type_id": "01234567-abcd-dcba-ffff-000000000000",
        "revision": 1
    }
}

🔴500Server Error