---
title: "Create Custom Index"
method: POST
path: "/api/consentmanager/v1/custom-indexes"
tags: ["Custom Index Management"]
---

# Create Custom Index

`POST /api/consentmanager/v1/custom-indexes`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/consentmanager/v1/custom-indexes`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `CONSENT`

Use this API to trigger the creation of a custom search index for data elements. The response will include the `runId` that can be used to query the current creation status using the [Get Index Creation Status API](https://developer.onetrust.com/onetrust/reference/getindexcreationstatus).

> 🗒 Things to Know
> 
> - Each account is limited to only one custom search index.

## Request body

- ConsentPreferencesUniversalConsentPreferenceManagPipelineTriggerRequest
  - `operationName` 'CREATE_DATA_ELEMENT_SEARCH_INDEX', required: The parameter representing the operation to be performed. Supported value is CREATE_DATA_ELEMENT_SEARCH_INDEX.
  - `parameters` object, required: Map of parameters required for the index creation. dataElementName parameter is mandatory for operation CREATE_DATA_ELEMENT_SEARCH_INDEX

## Response `200`

Index creation successfully triggered

- ConsentPreferencesUniversalConsentPreferenceManagPipelineTriggerResponse
  - `runId` string: Unique identifier for the pipeline run
  - `status` string: Status of the pipeline trigger

## Other responses

- `400`: Invalid request parameters
- `401`: Unauthorized access
- `403`: Insufficient permissions to create custom indexes
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/revisions/fe4a0697ec9d?raw)