---
title: "Apply generic HTTP enrichment"
method: POST
path: "/enrich/user-defined-http/{handle}/apply"
tags: ["enrich"]
---

# Apply generic HTTP enrichment

`POST /enrich/user-defined-http/{handle}/apply`

Applies a generic HTTP enrichment based on provided request parameters.

## Path parameters

- `handle` string, required

## Request body

- EnrichmentsRequest
  - `LaxValidation` boolean — internal only, skips live DNS validation steps to allow testing against local server
  - `body_escape_format` 'json' | 'none'
  - `body_template` string — Request body template string (with column id placeholders)
  - `bulk` EnrichmentsBulkProperties
    - `batch_size` integer
    - `results_path` string[]
  - `columns` ColumnsColumn[] — Columns with data used in enrichment requests
    - `FieldType` string
    - `Id` string
    - `Name` string — TODO: rename to Header (postponed for compatibility reasons)
    - `Origin` string — For external tables, the original column name.
  - `email_on_completion` string[] — List of email addresses to notify on completion
  - `filter_model` object — Filter model to apply
  - `headers` HttpHeader
  - `maximum_requests_per_second` number — Maximum number of requests per second
  - `method` string — http request method. 'GET', 'POST', 'PUT', 'PATCH'.
  - `output_path_map` EnrichmentsOutputMapping[] — Mapping of output to column
    - `name` string
    - `path` unknown[]
      - unknown
  - `recipe_id` string — Gigasheet recipe ID (optional)
  - `response_type` 'json' | 'raw' | 'unknown'
  - `retry_properties` EnrichmentsRetryProperties
    - `maximum_attempts` integer
    - `minimum_wait` integer — In nanoseconds.
    - `status_codes` integer[]
  - `sort_model` ClientstateSortModel[] — Sort models to apply
    - `colId` string
    - `pivotFieldGroupId` string — if pivot mode is enabled it can be sorted by pivot field group id (the column headers in pivot mode)
    - `sort` string
  - `url_template` string — URL template string (with column id placeholders)

## Response `200`

OK

- HttpHttpEnrichmentApplyResponse
  - `handle` string
  - `message` string
  - `success` boolean

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/freshdesk/apis/gigasheet-api.md) · [All operations](https://skmtc.net/freshdesk/apis/gigasheet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/freshdesk/gigasheet-api/versions/d1e5cbb24557/schema)