# Create a metafield definition validation

> Add a validation rule to a metafield definition.
{/* generated:versioned-pages - edit _pm-authored, not this file */}

`POST /api/metafield_definition_validations`

Creates a MetafieldDefinitionValidation resource.

Adds a validation rule to a metafield definition. Reference the `metafieldDefinition`, the validation `name` (type) and its `value`. The rule must be compatible with the definition’s type, otherwise it is rejected with `422`.

## Request body

| Property              | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Required | Description                                                                                                                         |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `metafieldDefinition` | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Yes      | The metafield definition this validation belongs to. Requires the `metafields:read` scope. Returned null when the scope is missing. |
| `name`                | `"/api/metafield_definition_validation_types/min_length" \| "/api/metafield_definition_validation_types/max_length" \| "/api/metafield_definition_validation_types/min_value" \| "/api/metafield_definition_validation_types/max_value" \| "/api/metafield_definition_validation_types/max_precision" \| "/api/metafield_definition_validation_types/json_schema" \| "/api/metafield_definition_validation_types/media_type" \| "/api/metafield_definition_validation_types/metaobject_definition"` | Yes      | The type of validation rule.                                                                                                        |
| `value`               | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Yes      | The validation parameter value. Format depends on the validation type.                                                              |

## Response

**201** - MetafieldDefinitionValidation resource created

| Property              | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Required | Description                                                                                                                        |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `@context`            | `string \| object`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | -        |                                                                                                                                    |
| `@id`                 | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Yes      |                                                                                                                                    |
| `@type`               | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Yes      |                                                                                                                                    |
| `id`                  | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | -        | The resource's unique identifier (UUID).                                                                                           |
| `metafieldDefinition` | `string \| null`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Yes      | The metafield definition this validation belongs to Requires the `metafields:read` scope. Returned null when the scope is missing. |
| `name`                | `"/api/metafield_definition_validation_types/min_length" \| "/api/metafield_definition_validation_types/max_length" \| "/api/metafield_definition_validation_types/min_value" \| "/api/metafield_definition_validation_types/max_value" \| "/api/metafield_definition_validation_types/max_precision" \| "/api/metafield_definition_validation_types/json_schema" \| "/api/metafield_definition_validation_types/media_type" \| "/api/metafield_definition_validation_types/metaobject_definition"` | Yes      | The type of validation rule                                                                                                        |
| `value`               | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Yes      | The validation parameter value. Format depends on the validation type.                                                             |

## Errors

**400** - Invalid input

| Property      | Type               | Required | Description                                                                                                                          |
| ------------- | ------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `@context`    | `string \| object` | -        |                                                                                                                                      |
| `@id`         | `string`           | Yes      |                                                                                                                                      |
| `@type`       | `string`           | Yes      |                                                                                                                                      |
| `code`        | `string`           | -        | Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.                |
| `description` | `string \| null`   | -        |                                                                                                                                      |
| `detail`      | `string \| null`   | -        | A human-readable explanation specific to this occurrence of the problem.                                                             |
| `instance`    | `string \| null`   | -        | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
| `message`     | `string`           | -        | End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.      |
| `slug`        | `string`           | -        | Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.                                    |
| `status`      | `integer \| null`  | -        |                                                                                                                                      |
| `title`       | `string \| null`   | -        | A short, human-readable summary of the problem. For a catalogued error it repeats the `slug`.                                        |
| `type`        | `string`           | -        | A URI reference that identifies the problem type. For a catalogued error it is the error code resource, `/api/error-codes/{code}`.   |

**403** - Access denied. The caller is missing one or more permissions required for this operation.

| Property             | Type               | Required | Description                                                                                                            |
| -------------------- | ------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| `@context`           | `string \| object` | -        |                                                                                                                        |
| `@id`                | `string`           | Yes      |                                                                                                                        |
| `@type`              | `string`           | Yes      |                                                                                                                        |
| `detail`             | `string`           | -        |                                                                                                                        |
| `missingPermissions` | `string[]`         | -        | Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission. |
| `status`             | `integer`          | -        |                                                                                                                        |
| `title`              | `string`           | -        |                                                                                                                        |
| `type`               | `string`           | -        |                                                                                                                        |

**422** - An error occurred

| Property      | Type               | Required | Description |
| ------------- | ------------------ | -------- | ----------- |
| `@context`    | `string \| object` | -        |             |
| `@id`         | `string`           | Yes      |             |
| `@type`       | `string`           | Yes      |             |
| `description` | `string`           | -        |             |
| `detail`      | `string`           | -        |             |
| `instance`    | `string \| null`   | -        |             |
| `status`      | `integer`          | -        |             |
| `title`       | `string \| null`   | -        |             |
| `type`        | `string`           | -        |             |
| `violations`  | `object[]`         | -        |             |

## Examples

### Example request

```bash
curl -X POST 'https://<tenant>.product-management.flowkiwi.net/api/metafield_definition_validations' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Flowkiwi-Api-Version: unstable' \
  -H 'Accept: application/ld+json' \
  -H 'Content-Type: application/ld+json' \
  -d '{
  "metafieldDefinition": "/api/metafield_definitions/019afb01-1a2b-7c3d-8e4f-0a1b2c3d4e5f",
  "name": "/api/metafield_definition_validation_types/max_length",
  "value": "500"
}'
```

### Example response

```json
{
  "@context": "/api/contexts/MetafieldDefinitionValidation",
  "@id": "/api/metafield_definition_validations/019afe01-1a2b-7c3d-8e4f-0a1b2c3d4e5f",
  "@type": "MetafieldDefinitionValidation",
  "id": "019afe01-1a2b-7c3d-8e4f-0a1b2c3d4e5f",
  "metafieldDefinition": "/api/metafield_definitions/019afb01-1a2b-7c3d-8e4f-0a1b2c3d4e5f",
  "name": "/api/metafield_definition_validation_types/max_length",
  "value": "500"
}
```