---
title: "Define target Field"
method: POST
path: "/field_mappings/define"
tags: ["fieldMappings"]
---

# Define target Field

`POST /field_mappings/define`

## Request body

- DefineTargetFieldDto
  - `object_type_owner` 'company' | 'contact' | 'deal' | 'lead' | 'note' | 'task' | 'engagement' | 'stage' | 'user', nullable, required
  - `name` string, nullable, required — The name of the target field
  - `description` string, nullable, required — The description of the target field
  - `data_type` 'string' | 'number', nullable, required — The data type of the target field

## Response `201`

- CustomFieldResponse
  - `id_attribute` string, nullable, required — Attribute Id
  - `status` string, nullable, required — Attribute Status
  - `ressource_owner_type` string, nullable, required — Attribute Ressource Owner Type
  - `slug` string, nullable, required — Attribute Slug
  - `description` string, nullable, required — Attribute Description
  - `data_type` 'string' | 'number', nullable, required — Attribute Data Type
  - `remote_id` string, nullable, required — Attribute Remote Id
  - `source` string, nullable, required — Attribute Source
  - `id_entity` string, nullable, required — Attribute Entity Id
  - `id_project` string, nullable, required — Attribute Project Id
  - `scope` string, nullable, required — Attribute Scope
  - `id_consumer` string, nullable, required — Attribute Consumer Id
  - `created_at` string, date-time, nullable, required — Attribute Created Date
  - `modified_at` string, date-time, nullable, required — Attribute Modified Date

## Changes

- **2024-08-05** `ca0fa45ebd05` — 2 breaking, 2 warning, 11 info
  - request property `data_type` was restricted to a list of enum values
  - request property `object_type_owner` was restricted to a list of enum values
  - added the new `number` enum value to the `data_type` response property for the response status `201`
  - added the new `string` enum value to the `data_type` response property for the response status `201`
  - …11 more
- **2024-08-05** `ca213ae36b7f` — 1 info
  - endpoint added
- **2024-08-05** `167edd5346ec` — 1 breaking
  - api path removed without deprecation
- **2024-08-03** `9d25bd589fe9` — 5 info
  - the request property `data_type` became nullable
  - the request property `description` became nullable
  - the request property `name` became nullable
  - the request property `object_type_owner` became nullable
  - …1 more
- **2024-08-01** `f48b82299d9d` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/panoratech/apis/panora-api-2/changes/field_mappings/define/post.md)

---

[API](https://skmtc.dev/panoratech/apis/panora-api-2.md) · [All operations](https://skmtc.dev/panoratech/apis/panora-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/panoratech/panora-api-2/revisions/ef360d76c658/schema)