> ## Documentation Index
> Fetch the complete documentation index at: https://developers.conveyour.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Validate a field

> Validates a field definition without saving it. Returns a success response if the definition is valid, or an error response with validation details if not.

Validate a field definition without saving



## OpenAPI

````yaml /api-reference/specs/fields.json post /api/fields/validate
openapi: 3.1.0
info:
  title: ConveYour API — Fields
  description: Create and manage custom contact fields for your org.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Fields
    description: Create and manage custom contact fields for your org.
paths:
  /api/fields/validate:
    post:
      tags:
        - Fields
      summary: Validate a field
      description: >-
        Validates a field definition without saving it. Returns a success
        response if the definition is valid, or an error response with
        validation details if not.


        Validate a field definition without saving
      operationId: validateAFieldDefinitionWithoutSaving
      parameters:
        - $ref: '#/components/parameters/teams'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                A candidate field definition. Validation runs the same checks as
                creating the field, without saving anything.
              properties:
                bucket:
                  type: integer
                  description: >-
                    Target bucket ID. Defaults to the org's default bucket when
                    omitted.
                label:
                  type: string
                  description: Display label. Used to generate name when name is omitted.
                name:
                  type: string
                  description: Machine name. Generated from label when omitted.
                type:
                  type: string
                  description: Field type.
              additionalProperties:
                description: Any other field-definition key accepted on create.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/NoData'
              example:
                status: ok
                message: success
                data: []
        '403':
          $ref: '#/components/responses/ForbiddenToken'
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    NoData:
      type: array
      items: {}
      maxItems: 0
      description: No payload — `data` is an empty array.
  responses:
    ForbiddenToken:
      description: >-
        The token is missing, expired, or not permitted for this HTTP method.
        **This endpoint enforces no named permission**, so a 403 here never
        carries a `permission` field.
      content:
        application/json:
          example:
            status: failed
            message: Token is either expired or does not have the correct permissions
            data: []
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.