--- title: "Contacts.update" method: PATCH path: "/entities/Contacts/{id}" tags: ["Contact"] --- # Contacts.update `PATCH /entities/Contacts/{id}` Modifies Contact or Contacts with given id(s) ## Path parameters - `id` string, uuid, required ## Query parameters - `validation-level` integer ## Request body - UpdateContactInput - `created` string, date-time — Creation time. - `picture` object — Profile picture associated with the contact. Relation to CloudObject, see: 'updateCloudObjectInput' object for properties. - `id` string, uri - `address` string — Street address of the contact. - `city` string — City of the contact address. - `comments` string — Free-form notes describing the contact. - `contact_type_id` string, uuid — Id of the contact type assigned to this contact. - `country` string — Country of the contact address. - `currency_exchange_rates_list_id` string, uuid — Id of the currency exchange rate list applied to this contact. - `email1` string — Primary email address of the contact. Used as default recipient for emails sent from Coevera. - `email2` string — Additional email address. - `email3` string — Additional email address. - `email4` string — Additional email address. - `email5` string — Additional email address. - `first_name` string — Given name of the contact. - `gender` 0 | 1 | 2 | 3 — Gender of the contact (e.g. Male, Female, Other). Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary - `is_archived` boolean — True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. - `last_name` string — Family name of the contact. - `middle_name` string — Middle name of the contact, if applicable. - `owner_id` string, uuid — Id of the contact owner. - `phone1` string — Primary phone number of the contact. Used as default target for click-to-call. - `phone2` string — Additional phone number. - `phone3` string — Additional phone number. - `phone4` string — Additional phone number. - `phone5` string — Additional phone number. - `picture_id` string, uuid — Id of the profile picture document. - `position` string — Job title or position of the contact. - `quick_account_name` string — Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. - `share_mode` 0 | 1 | 2 | 3 — Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit - `state_province` string — State or province of the contact address. - `title` string — Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. - `unit_id` string, uuid — Id of the sales unit. - `zip_code` string — ZIP or postal code of the contact address. - `revision` integer — Revision when entity was lastly changed. - `social_media` object — Social network profiles linked to this contact (e.g. LinkedIn, Facebook). Relation to ContactSocialRelation, see: 'updateContactSocialRelationInput' object for properties. - `id` string, uri - `account_relations` object[] — Accounts this contact is linked to. Each link records the role and position the contact has at the related account. - `id` string, uri - `sharing_units` object[] — Sales units that have been granted shared access to this contact. Editable only when share_mode allows unit sharing. - `id` string, uri - `sharing_clients` object[] — Users that have been granted shared access to this contact. Editable only when share_mode allows user sharing. - `id` string, uri - `documents` object[] — Documents linked to this contact. - `id` string, uri - `exchange_entity_id` string — External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. - `gapi_entity_id` string — External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. - `o365_entity_id` string — External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. - `primary_account_account_roles` object[] — Roles of Contact in his primary Account. - `id` string, uri - `account_position` string — Job position of Contact in his primary Account or quick account position if Contact has no primary Account. - `is_unsubscribed` boolean — If account has any unsubscribed email. - `tags` object[] — Tag labels applied to this contact. - `id` string, uri - `static_profiles` object[] — Saved view profiles this contact currently matches. - `id` string, uri - `primary_account_relationship` string — Org chart relationship of Contact in his primary Account. ## Response `200` Modification confirmation. Returns resulting Contact - object - `success` boolean — True when response succeeded, false on error. - `data` Contact - `is_delete_protected` boolean, required — 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. - `id` string, uuid, required — Unique identifier of entity. - `is_deleted` boolean — Specifies if the entity is considered deleted. - `modified` string, date-time — Last modification time. - `created` string, date-time — Creation time. - `contact_type` string, uri, required — Contact type that classifies this contact. Contact types are configurable per team space and drive which form, fields and pipelines apply. 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 — Currency exchange rate list used to convert monetary fields linked to this contact. Empty to inherit the team space default. 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 — Sales user who owns this contact. 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 — Profile picture associated with the contact. 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 — Sales unit this contact is assigned to. Determines which team members can see the record under unit-based sharing. 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 — Street address of the contact. - `city` string — City of the contact address. - `comments` string — Free-form notes describing the contact. - `contact_type_id` string, uuid — Id of the contact type assigned to this contact. - `country` string — Country of the contact address. - `currency_exchange_rates_list_id` string, uuid — Id of the currency exchange rate list applied to this contact. - `email1` string — Primary email address of the contact. Used as default recipient for emails sent from Coevera. - `email2` string — Additional email address. - `email3` string — Additional email address. - `email4` string — Additional email address. - `email5` string — Additional email address. - `first_name` string — Given name of the contact. - `gender` 0 | 1 | 2 | 3 — Gender of the contact (e.g. Male, Female, Other). Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary - `is_archived` boolean — True when the contact has been archived. Archived contacts remain readable but are hidden from active lists and cannot be edited until reactivated. - `last_name` string — Family name of the contact. - `middle_name` string — Middle name of the contact, if applicable. - `owner_id` string, uuid, required — Id of the contact owner. - `phone1` string — Primary phone number of the contact. Used as default target for click-to-call. - `phone2` string — Additional phone number. - `phone3` string — Additional phone number. - `phone4` string — Additional phone number. - `phone5` string — Additional phone number. - `picture_id` string, uuid — Id of the profile picture document. - `position` string — Job title or position of the contact. - `quick_account_name` string — Free-text company name used when the contact is not linked to an actual Account record. Lets integrators capture the company without creating a separate Account. - `share_mode` 0 | 1 | 2 | 3 — Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit - `state_province` string — State or province of the contact address. - `title` string — Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name. - `unit_id` string, uuid — Id of the sales unit. - `zip_code` string — ZIP or postal code of the contact address. - `revision` integer — Revision when entity was lastly changed. - `formatted_name` string, required — Display version of the contact name (title, first, middle, last). Used in lists and references. - `social_media` string, uri — Social network profiles linked to this contact (e.g. LinkedIn, Facebook). 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 — Primary account this contact belongs to. Set automatically when the contact has an account relation marked as primary. 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` string[] — Accounts this contact is linked to. Each link records the role and position the contact has at the related account. - `sharing_units` string[] — Sales units that have been granted shared access to this contact. Editable only when share_mode allows unit sharing. - `sharing_clients` string[] — Users that have been granted shared access to this contact. Editable only when share_mode allows user sharing. - `documents` string[] — Documents linked to this contact. - `exchange_entity_id` string — External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. - `gapi_entity_id` string — External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. - `o365_entity_id` string — External identifier of the record in the linked third-party service (e.g. Google, Microsoft 365, Exchange). Maintained by the sync engine. - `is_favorite` boolean, required — True when the current authenticated user has marked this contact as favorite. Per-user. - `primary_account_account_roles` string[] — Roles of Contact in his primary Account. - `primary_account_position` string — Job position of Contact in his primary Account. - `account_position` string — Job position of Contact in his primary Account or quick account position if Contact has no primary Account. - `is_unsubscribed` boolean — If account has any unsubscribed email. - `tags` string[] — Tag labels applied to this contact. - `static_profiles` string[] — Saved view profiles this contact currently matches. - `primary_account_relationship` string — Org chart relationship of Contact in his primary Account. - `modified_by_user` string, date-time — Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. ## Other responses - `404` — Sent when invalid ID is given - `500` — unexpected error --- [API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)