COcoevera
Field

FieldMappings.update

Changes fields of the FieldMapping record with the given id; fields left out keep their values.

patch/entities/FieldMappings/{id}

Request

Path parameters

idstring uuid required

Id of the FieldMapping record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

is_systemboolean

True when the mapping is shipped by the platform and cannot be deleted by the user.

mappingstring binary

Default field-to-field mapping template applied when no per-type-pair mapping matches.

operation1 | 2 | 3 | 4 | 5 | 6

Situation in which the mapping pre-fills a new target record from a source record, such as qualifying a lead into an opportunity or creating a follow-up activity.

Integer enum value: 1 - Default, 2 - Qualification, 3 - FollowUp, 4 - Parent, 5 - QualificationAndAutocreate, 6 - Conversion

type_mappingsstring binary

Per-type-pair field mappings: each entry binds a set of source/target type ids and the field-to-field mapping that applies when both types match.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "mapping": "blob",
  "operation": 1,
  "type_mappings": "blob",
  "revision": 1
}

Response

The changed FieldMapping record.

successboolean

True when the request 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",
    "mapping": "blob",
    "operation": 1,
    "source_entity_api_name": "string",
    "target_entity_api_name": "string",
    "type_mappings": "blob",
    "revision": 1,
    "source_entity_name": "string",
    "target_entity_name": "string"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.