---
title: "ImportMappingMasks.update"
method: PATCH
path: "/entities/ImportMappingMasks/{id}"
tags: ["Import"]
---

# ImportMappingMasks.update

`PATCH /entities/ImportMappingMasks/{id}`

Modifies ImportMappingMask or ImportMappingMasks with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateImportMappingMaskInput
  - `entity_api_name` string — API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name).
  - `entity_type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice, 8 - CustomEntity
  - `mapping` object — Import mapping mask/relation_types in json format
  - `name` string — Display name of the mask.
  - `owner_id` string, uuid — Id of the owning user.
  - `relation_types` object — Import mapping mask/relation_types in json format
  - `share_mode` 0 | 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers
  - `revision` integer — Revision when entity was lastly changed.
  - `sharing_clients` object[] — Users granted shared access to this import mapping mask (custom share mode).
    - `id` string, uri
  - `sharing_units` object[] — Sales units granted shared access to this import mapping mask (custom share mode).
    - `id` string, uri

## Response `200`

Modification confirmation. Returns resulting ImportMappingMask

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` ImportMappingMask
    - `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.
    - `owner` string, uri, required — User who owns the import mapping mask. 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.
    - `entity_api_name` string — API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name).
    - `entity_type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8, required — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Lead, 2 - Opportunity, 3 - Account, 4 - Contact, 5 - Client, 6 - Product, 7 - ProductPriceListPrice, 8 - CustomEntity
    - `mapping` object, required — Import mapping mask/relation_types in json format
    - `name` string, required — Display name of the mask.
    - `owner_id` string, uuid, required — Id of the owning user.
    - `relation_types` object — Import mapping mask/relation_types in json format
    - `share_mode` 0 | 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers
    - `revision` integer — Revision when entity was lastly changed.
    - `sharing_clients` string[] — Users granted shared access to this import mapping mask (custom share mode).
    - `sharing_units` string[] — Sales units granted shared access to this import mapping mask (custom share mode).

## 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)