Contacts.update - PipelinerCRM

Modifies Contact or Contacts with given id(s)

Request

Path Params

string <uuid>

required

ID of Contact to update

Query Params

validation-level

integer <int32>

optional

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

created

string <date-time>

optional

Creation time.

Example:

2019-01-01T00:00:00

picture

object

optional

Relation to CloudObject, see: 'updateCloudObjectInput' object for properties.

string <uri>

optional

address

string

optional

Multi-line text input field.

Example:

string

city

string

optional

Simple text input field.

Example:

string

comments

string

optional

Multi-line text input field.

Example:

string

contact_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

country

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email1

string

optional

Email address.

Example:

string

email2

string

optional

Email address.

Example:

string

email3

string

optional

Email address.

Example:

string

email4

string

optional

Email address.

Example:

string

email5

string

optional

Email address.

Example:

string

first_name

string

optional

Simple text input field.

Example:

string

gender

enum<integer>

optional

Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary

Allowed values:

0123

Example:

is_archived

boolean

optional

Boolean value.

Example:

false

last_name

string

optional

Simple text input field.

Example:

string

middle_name

string

optional

Simple text input field.

Example:

string

owner_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

phone1

string

optional

Phone number.

Example:

string

phone2

string

optional

Phone number.

Example:

string

phone3

string

optional

Phone number.

Example:

string

phone4

string

optional

Phone number.

Example:

string

phone5

string

optional

Phone number.

Example:

string

picture_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

position

string

optional

Simple text input field.

Example:

string

quick_account_name

string

optional

Simple text input field.

Example:

string

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

state_province

string

optional

Simple text input field.

Example:

string

title

string

optional

Simple text input field.

Example:

string

unit_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

zip_code

string

optional

Simple text input field.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

social_media

object

optional

Relation to ContactSocialRelation, see: 'updateContactSocialRelationInput' object for properties.

string <uri>

optional

account_relations

array [object {1}]

optional

Relations to Accounts.

string <uri>

optional

sharing_units

array [object {1}]

optional

Relations to SalesUnits.

string <uri>

optional

sharing_clients

array [object {1}]

optional

Relations to Clients.

string <uri>

optional

documents

array [object {1}]

optional

Relations to CloudObjects.

string <uri>

optional

exchange_entity_id

string

optional

Example:

string

gapi_entity_id

string

optional

Example:

string

o365_entity_id

string

optional

Example:

string

primary_account_account_roles

array [object {1}]

optional

Roles of Contact in his primary Account.

string <uri>

optional

account_position

string

optional

Job position of Contact in his primary Account or quick account position if Contact has no primary Account.

Example:

string

is_unsubscribed

boolean

optional

If account has any unsubscribed email.

Example:

false

tags

array [object {1}]

optional

Relations to Tags.

string <uri>

optional

static_profiles

array [object {1}]

optional

Relations to Profiles.

string <uri>

optional

primary_account_relationship

string

optional

Org chart relationship of Contact in his primary Account.

Example:

string

Example

{
    "created": "2019-01-01T00:00:00",
    "picture": {
        "id": "http://example.com"
    },
    "address": "string",
    "city": "string",
    "comments": "string",
    "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "country": "string",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "email1": "string",
    "email2": "string",
    "email3": "string",
    "email4": "string",
    "email5": "string",
    "first_name": "string",
    "gender": 0,
    "is_archived": false,
    "last_name": "string",
    "middle_name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone1": "string",
    "phone2": "string",
    "phone3": "string",
    "phone4": "string",
    "phone5": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "position": "string",
    "quick_account_name": "string",
    "share_mode": 0,
    "state_province": "string",
    "title": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "zip_code": "string",
    "revision": 1,
    "social_media": {
        "id": "http://example.com"
    },
    "account_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "sharing_units": [
        {
            "id": "http://example.com"
        }
    ],
    "sharing_clients": [
        {
            "id": "http://example.com"
        }
    ],
    "documents": [
        {
            "id": "http://example.com"
        }
    ],
    "exchange_entity_id": "string",
    "gapi_entity_id": "string",
    "o365_entity_id": "string",
    "primary_account_account_roles": [
        {
            "id": "http://example.com"
        }
    ],
    "account_position": "string",
    "is_unsubscribed": false,
    "tags": [
        {
            "id": "http://example.com"
        }
    ],
    "static_profiles": [
        {
            "id": "http://example.com"
        }
    ],
    "primary_account_relationship": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/entities/Contacts/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "created": "2019-01-01T00:00:00",
    "picture": {
        "id": "http://example.com"
    },
    "address": "string",
    "city": "string",
    "comments": "string",
    "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "country": "string",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "email1": "string",
    "email2": "string",
    "email3": "string",
    "email4": "string",
    "email5": "string",
    "first_name": "string",
    "gender": 0,
    "is_archived": false,
    "last_name": "string",
    "middle_name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone1": "string",
    "phone2": "string",
    "phone3": "string",
    "phone4": "string",
    "phone5": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "position": "string",
    "quick_account_name": "string",
    "share_mode": 0,
    "state_province": "string",
    "title": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "zip_code": "string",
    "revision": 1,
    "social_media": {
        "id": "http://example.com"
    },
    "account_relations": [
        {
            "id": "http://example.com"
        }
    ],
    "sharing_units": [
        {
            "id": "http://example.com"
        }
    ],
    "sharing_clients": [
        {
            "id": "http://example.com"
        }
    ],
    "documents": [
        {
            "id": "http://example.com"
        }
    ],
    "exchange_entity_id": "string",
    "gapi_entity_id": "string",
    "o365_entity_id": "string",
    "primary_account_account_roles": [
        {
            "id": "http://example.com"
        }
    ],
    "account_position": "string",
    "is_unsubscribed": false,
    "tags": [
        {
            "id": "http://example.com"
        }
    ],
    "static_profiles": [
        {
            "id": "http://example.com"
        }
    ],
    "primary_account_relationship": "string"
}'

Responses

🟢200OK

application/json

Modification confirmation. Returns resulting Contact

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Contact)

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>

optional

Creation time.

Example:

2019-01-01T00:00:00

contact_type

string <uri>

required

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

currency_exchange_rates_list

string <uri>

optional

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

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.

picture

string <uri>

optional

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

unit

string <uri>

required

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

address

string

optional

Multi-line text input field.

Example:

string

city

string

optional

Simple text input field.

Example:

string

comments

string

optional

Multi-line text input field.

Example:

string

contact_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

country

string

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email1

string

optional

Email address.

Example:

string

email2

string

optional

Email address.

Example:

string

email3

string

optional

Email address.

Example:

string

email4

string

optional

Email address.

Example:

string

email5

string

optional

Email address.

Example:

string

first_name

string

optional

Simple text input field.

Example:

string

gender

enum<integer>

optional

Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary

Allowed values:

0123

Example:

is_archived

boolean

optional

Boolean value.

Example:

false

last_name

string

optional

Simple text input field.

Example:

string

middle_name

string

optional

Simple text input field.

Example:

string

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

phone1

string

optional

Phone number.

Example:

string

phone2

string

optional

Phone number.

Example:

string

phone3

string

optional

Phone number.

Example:

string

phone4

string

optional

Phone number.

Example:

string

phone5

string

optional

Phone number.

Example:

string

picture_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

position

string

optional

Simple text input field.

Example:

string

quick_account_name

string

optional

Simple text input field.

Example:

string

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

state_province

string

optional

Simple text input field.

Example:

string

title

string

optional

Simple text input field.

Example:

string

unit_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

zip_code

string

optional

Simple text input field.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

formatted_name

string

required

Example:

string

social_media

string <uri>

optional

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

primary_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.

account_relations

array[string <uri>]

optional

Relations to Accounts.

sharing_units

array[string <uri>]

optional

Relations to SalesUnits.

sharing_clients

array[string <uri>]

optional

Relations to Clients.

documents

array[string <uri>]

optional

Relations to CloudObjects.

exchange_entity_id

string

optional

Example:

string

gapi_entity_id

string

optional

Example:

string

o365_entity_id

string

optional

Example:

string

is_favorite

boolean

required

Example:

false

primary_account_account_roles

array[string <uri>]

optional

Roles of Contact in his primary Account.

primary_account_position

string

optional

Job position of Contact in his primary Account.

Example:

string

account_position

string

optional

Job position of Contact in his primary Account or quick account position if Contact has no primary Account.

Example:

string

is_unsubscribed

boolean

optional

If account has any unsubscribed email.

Example:

false