---
title: "Add AI Custom Placeholder"
method: POST
path: "/ai/settings/custom-placeholders"
tags: ["AI"]
deprecated: true
---

# Add AI Custom Placeholder

`POST /ai/settings/custom-placeholders`

## Request

- Base URL: `https://api.crowdin.com/api/v2`
- URL: `https://api.crowdin.com/api/v2/ai/settings/custom-placeholders`
- Auth: none declared
- TypeScript: <https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/docs/ai/settings/custom-placeholders/post.ts> (a function with typed inputs; its response is checked against the schema)

> **Deprecated.**

**Required scopes:** `ai.prompt` (Read and Write).

Use [Add AI Snippet](#operation/api.ai.prompts.snippets.post) instead.

## Request body

- AiCustomPlaceholderCreateForm
  - `description` string, required: The description must be unique and must be between 3 and 255 characters.
  - `placeholder` string, required: The placeholder must be unique and must start with `%custom:` and end with `%`. Allowed characters: `a-z`, `A-Z`, `0-9`, `-`. The full length must not exceed 255 characters.
  - `value` string, required: The text that will be utilized in the prompt. The value must not exceed 4000 characters.

## Response `201`

AI Custom Placeholder was added successfully

- AiCustomPlaceholderResource: Base schema of resource container. Container is a wrapper object that contains payload in required `data` property and provides space for adding any other metadata.
  - `data` AiCustomPlaceholder, required
    - `id` integer
    - `description` string
    - `placeholder` string
    - `value` string
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

## Other responses

- `400`: Invalid Request Parameters
- `401`: Unauthorized
- `403`: Forbidden
- `405`: Method Not Allowed

---

[API](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2.md) - [All operations](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/crowdin/apis/crowdin-enterprise-api-v2/revisions/dc68744c5384?raw)
