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

# Map the columns of a contact file

> What each column holds, by index: `phone` (one column, required), `first_name`, `last_name`, `email`, `var:<key>` or `ignore`.



## OpenAPI

````yaml /api-reference/v2.0/openapi.json patch /campaign-imports/{id}
openapi: 3.1.0
info:
  title: Shortext API
  description: >-
    **Versioning**: every version is a frozen contract. A released version only
    receives additive changes

    (new endpoints, new optional fields, new response fields); anything breaking
    ships in a new version.

    Responses carry `X-Shortext-Api-Version`. When a version is scheduled for
    removal, responses also carry

    `Deprecation` and `Sunset` headers; after the sunset date the version
    answers HTTP 410.

    The list of versions and their status is available at `GET /api/versions`.


    **Responses**: always HTTP 200. Check `success` and `code` (`1000` =
    success), see `ApiEnvelope`.

    On failure, `trace_id` identifies the request for support.


    **Rate limit**: 300 requests per minute per company, shared by all its keys
    and by every API version.

    Responses carry `X-RateLimit-Limit` and `X-RateLimit-Remaining`; beyond the
    limit the API answers

    HTTP 429 with `Retry-After` (seconds) and the usual envelope. Prefer
    webhooks to polling.
  version: '2.0'
servers:
  - url: https://shortext.ny-corp.io/api/v2.0
security: []
tags:
  - name: Agents
    description: Agents
  - name: Knowledge
    description: Knowledge
  - name: Dynamic links
    description: Dynamic links
  - name: Billing
    description: Billing
  - name: Campaigns
    description: Campaigns
  - name: Channels
    description: Channels
  - name: Conversations
    description: Conversations
  - name: Follow-ups
    description: Follow-ups
  - name: Account
    description: Account
  - name: Tickets
    description: Tickets
  - name: Templates
    description: Templates
  - name: Hosted sessions
    description: Hosted sessions
  - name: Webhooks
    description: Webhooks
paths:
  /campaign-imports/{id}:
    patch:
      tags:
        - Campaigns
      summary: Map the columns of a contact file
      description: >-
        What each column holds, by index: `phone` (one column, required),
        `first_name`, `last_name`, `email`, `var:<key>` or `ignore`.
      operationId: mapCampaignImport
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                columns:
                  type: object
                  example:
                    - phone
                    - first_name
                    - var:amount
                has_header:
                  type: boolean
                  default: true
              type: object
      responses:
        '200':
          description: >-
            Always HTTP 200: the outcome is in `success` and `code` (absolute
            value of the response code).
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiEnvelope'
                  - properties:
                      body:
                        $ref: '#/components/schemas/CampaignImport'
                    type: object
      security:
        - bearerAuth: []
components:
  schemas:
    ApiEnvelope:
      properties:
        success:
          type: boolean
          example: true
        code:
          type: integer
          example: 1000
        message:
          type: string
          example: Request success.
        body:
          description: Endpoint payload, null when there is none
        token:
          description: Present only on authentication routes
          type:
            - string
            - 'null'
        trace_id:
          description: Present only when success is false
          type:
            - string
            - 'null'
      type: object
    CampaignImport:
      properties:
        id:
          type: string
          example: IMP-XXXXX
        file_name:
          type: string
        rows:
          type: integer
        has_header:
          type: boolean
        status:
          type: string
          enum:
            - uploaded
            - mapped
            - checking
            - checked
            - applying
            - validated
            - failed
        columns:
          type: array
          items:
            properties:
              index:
                type: integer
              header:
                type: string
              samples:
                type: array
                items:
                  type: string
              target:
                description: >-
                  `phone` (required), `first_name`, `last_name`, `email`,
                  `var:<key>` (a variable for the message) or `ignore`
                type: string
            type: object
        report:
          description: >-
            After the check: rows, valid, duplicates, invalid (with
            invalid_rows: row, value, reason), opted_out, new_contacts
          type:
            - object
            - 'null'
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        Company API key, sent as `Authorization: Bearer <key>`. Create it in the
        dashboard (Developer > API Keys) with the permissions the integration
        needs.
      scheme: bearer

````

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