v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Import

ImportMappingMasks.update

Modifies ImportMappingMask or ImportMappingMasks with given id(s)

patch/entities/ImportMappingMasks/{id}

Path parameters

idstring uuid required

ID of ImportMappingMask to update

Query parameters

validation-levelinteger

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

Request body

entity_api_namestring

API name of the entity this mask is configured for (e.g. "Account", "Contact", a custom entity's API name).

entity_type1 | 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

mappingobject

Import mapping mask/relation_types in json format

namestring

Display name of the mask.

owner_idstring uuid

Id of the owning user.

relation_typesobject

Import mapping mask/relation_types in json format

share_mode0 | 1 | 2

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - Private, 2 - Public, 0 - SelectedUnitsAndUsers

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "entity_api_name": "string",
  "entity_type": 1,
  "name": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

Modification confirmation. Returns resulting ImportMappingMask

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "entity_api_name": "string",
    "entity_type": 1,
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}