/target-fields

curl -X POST https://api.merge.dev/api/crm/v1/target-fields \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "employee_favorite_team",
  "common_model": "Employee"
}'

{
  "Account": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Contact": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Lead": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Note": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Opportunity": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Stage": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "User": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Task": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Engagement": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ]
}

Create a new organization-wide Target Field. Target Fields are custom fields that your organization defines to collect supplemental data from integrations. Learn more.

Create a new organization-wide Target Field. Target Fields are custom fields that your organization defines to collect supplemental data from integrations. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Request

This endpoint expects an object.

namestringRequired>=1 character

The name of the target field.

common_modelstringRequired>=1 character

The name of the Common Model to associate the target field with.

descriptionstringOptional>=1 characterDefaults to

The description of the target field.

Response

Accountlist of objectsOptional

Contactlist of objectsOptional

Leadlist of objectsOptional

Notelist of objectsOptional

Opportunitylist of objectsOptional

Stagelist of objectsOptional

Userlist of objectsOptional

Tasklist of objectsOptional

Engagementlist of objectsOptional

1	{
2	"Account": [
3	{
4	"name": "example_target_field_name",
5	"description": "this is a example description of a target field",
6	"is_mapped": "true"
7	}
8	],
9	"Contact": [
10	{
11	"name": "example_target_field_name",
12	"description": "this is a example description of a target field",
13	"is_mapped": "true"
14	}
15	],
16	"Lead": [
17	{
18	"name": "example_target_field_name",
19	"description": "this is a example description of a target field",
20	"is_mapped": "true"
21	}
22	],
23	"Note": [
24	{
25	"name": "example_target_field_name",
26	"description": "this is a example description of a target field",
27	"is_mapped": "true"
28	}
29	],
30	"Opportunity": [
31	{
32	"name": "example_target_field_name",
33	"description": "this is a example description of a target field",
34	"is_mapped": "true"
35	}
36	],
37	"Stage": [
38	{
39	"name": "example_target_field_name",
40	"description": "this is a example description of a target field",
41	"is_mapped": "true"
42	}
43	],
44	"User": [
45	{
46	"name": "example_target_field_name",
47	"description": "this is a example description of a target field",
48	"is_mapped": "true"
49	}
50	],
51	"Task": [
52	{
53	"name": "example_target_field_name",
54	"description": "this is a example description of a target field",
55	"is_mapped": "true"
56	}
57	],
58	"Engagement": [
59	{
60	"name": "example_target_field_name",
61	"description": "this is a example description of a target field",
62	"is_mapped": "true"
63	}
64	]
65	}

Authentication

Headers

Request

Response