ContactAccountRelations.update

Modifies ContactAccountRelation or ContactAccountRelations with given id(s)

Request

Path Params

string <uuid>

required

ID of ContactAccountRelation to update

Query Params

validation-level

integer <int32>

optional

Specify validation level of ContactAccountRelation on update. 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

comment

string

optional

Simple text input field.

Example:

string

contact_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

is_assistant

boolean

optional

Boolean value.

Example:

false

is_primary

boolean

optional

Boolean value.

Example:

false

is_sibling

boolean

optional

Boolean value.

Example:

false

position

string

optional

Simple text input field.

Example:

string

relationship

enum<integer>

optional

Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong

Allowed values:

0123

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

account_roles

array [object {1}]

optional

Relations to AccountRoles.

string <uri>

optional

Example

{
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "comment": "string",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "is_assistant": false,
    "is_primary": false,
    "is_sibling": false,
    "position": "string",
    "relationship": 0,
    "revision": 1,
    "account_roles": [
        {
            "id": "http://example.com"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting ContactAccountRelation

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (ContactAccountRelation)

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>

required

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>

required

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.

account_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

comment

string

optional

Simple text input field.

Example:

string

contact_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

is_assistant

boolean

optional

Boolean value.

Example:

false

is_primary

boolean

required

Boolean value.

Example:

false

is_sibling

boolean

optional

Boolean value.

Example:

false

position

string

optional

Simple text input field.

Example:

string

relationship

enum<integer>

optional

Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong

Allowed values:

0123

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

account_roles

array[string <uri>]

optional

Relations to AccountRoles.

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",
        "account_id": "01234567-abcd-dcba-ffff-000000000000",
        "comment": "string",
        "contact_id": "01234567-abcd-dcba-ffff-000000000000",
        "is_assistant": false,
        "is_primary": false,
        "is_sibling": false,
        "position": "string",
        "relationship": 0,
        "revision": 1,
        "account_roles": [
            "http://example.com"
        ]
    }
}

🟠404Record Not Found

🔴500Server Error