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

# Create Mapping

> Create a custom field mapping. Provide exactly one of `integration_slug` (organization scope) or `connector_token` (connector scope).



## OpenAPI

````yaml post /api/v1/custom-fields/mapping
openapi: 3.1.0
info:
  title: Bindbee APIs
  version: 0.1.0
servers: []
security: []
paths:
  /api/v1/custom-fields/mapping:
    post:
      tags:
        - Custom Fields
      summary: Create Custom Field Mapping
      description: >-
        Create a custom field mapping. Provide exactly one of `integration_slug`
        (organization scope) or `connector_token` (connector scope).
      operationId: create_custom_field_mapping_api_v1_custom_fields_mapping_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFieldMappingCreateExternal'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: >-
                  Response Create Custom Field Mapping Api V1 Custom Fields
                  Mapping Post
        '401':
          description: Missing or invalid bearer authentication credentials.
          headers:
            WWW-Authenticate:
              description: Bearer authentication challenge.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            The credentials are valid but do not permit access to this resource,
            e.g. a connector token used on a different API category or a model
            whose writes are disabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded.
          headers:
            X-RateLimit-Limit:
              description: Maximum requests allowed in the current window.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests remaining in the current window.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: >-
                Unix timestamp (seconds since epoch) at which the current
                rate-limit window resets.
              schema:
                type: integer
            Retry-After:
              description: Seconds to wait before retrying the request.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - HTTPBearer: []
components:
  schemas:
    CustomFieldMappingCreateExternal:
      properties:
        custom_field_id:
          type: string
          format: uuid
          title: Custom Field Id
          description: ID of the custom field to be mapped.
          examples:
            - 018e586b-7d0b-7bc9-be65-a8fdbc82d734
        integration_slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Integration Slug
          description: >-
            Integration slug — set this for an organization-scoped mapping
            (applies to all connectors of this integration in the org). Mutually
            exclusive with `connector_token`.
          examples:
            - workday
        connector_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Connector Token
          description: >-
            Connector token — set this for a connector-scoped mapping (applies
            to a single connector instance). Mutually exclusive with
            `integration_slug`.
          examples:
            - i5kqe8bSedEdPLX9pHhFojKdo7Uzvue0f7I4NVhaDfV0GTxF0uAgwa_COb3zZU3T
        json_path:
          type: string
          maxLength: 1024
          pattern: \S.*\S
          title: Json Path
          description: JMESPath expression to extract the value from the upstream payload.
      type: object
      required:
        - custom_field_id
        - json_path
      title: CustomFieldMappingCreateExternal
    ErrorResponse:
      type: object
      required:
        - detail
      properties:
        detail:
          type: string
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````