Enrichment Fields | Polytomic Docs

Returns the valid input field sets for an enrichment configuration on a connection. When configuring an enrichment source in a model sync, use this endpoint to discover which input fields the enrichment connection requires. Pass the proposed enrichment configuration in the request body; the response lists the valid input field sets that map your model's fields to the enrichment service's expected inputs.

Returns the valid input field sets for an enrichment configuration on a connection.

When configuring an enrichment source in a model sync, use this endpoint to discover which input fields the enrichment connection requires. Pass the proposed enrichment configuration in the request body; the response lists the valid input field sets that map your model’s fields to the enrichment service’s expected inputs.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

connection_idstringRequiredformat: "uuid"

Headers

X-Polytomic-VersionstringRequired

Request

This endpoint expects an object.

configurationmap from strings to anyOptional

Similar to a model configuration, this configures the enricher. For example, if you wanted to use Apollo to enrich people, you would send {"object": "people"} as the configuration. Each enricher configuration can be found in the connection configuration docs.

Response

datalist of lists of strings or null

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Returns the valid input field sets for an enrichment configuration on a connection.

This is the Polytomic deployment key (on-premises only)

This is the Polytomic API key

This endpoint expects an object.

$	curl -X POST https://app.polytomic.com/api/enrichment/248df4b7-aa70-47b8-a036-33ac447e668d/inputfields \
>	-H "X-Polytomic-Version: X-Polytomic-Version" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{}'

1	{
2	"data": [
3	[
4	"email",
5	"first_name",
6	"last_name"
7	],
8	[
9	"phone_number",
10	"full_name"
11	],
12	[
13	"company_name",
14	"domain"
15	]
16	]
17	}

$	curl -X POST https://app.polytomic.com/api/enrichment/248df4b7-aa70-47b8-a036-33ac447e668d/inputfields \
>	-H "X-Polytomic-Version: X-Polytomic-Version" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{}'

1	{
2	"data": [
3	[
4	"email",
5	"first_name",
6	"last_name"
7	],
8	[
9	"phone_number",
10	"full_name"
11	],
12	[
13	"company_name",
14	"domain"
15	]
16	]
17	}