> ## Documentation Index > Fetch the complete documentation index at: https://docs.brudcast.com/llms.txt > Use this file to discover all available pages before exploring further. # Preview a contact import > Dry-runs the uploaded file against the proposed mappings and answers with the counts the confirmation step needs. No contacts are written and nothing about the proposal is persisted, so the same draft can be previewed repeatedly with different mappings. `sampleErrors` is capped at the first ten failing rows. Requires the `contacts:write` scope. ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/user/contact-imports/{id}/preview openapi: 3.0.0 info: title: Brudcast API version: 1.0.0 servers: - url: https://core-service.prod.brudcast.com description: Production security: [] tags: - name: Analytics x-displayName: Analytics - name: Campaigns x-displayName: Campaigns - name: Contacts x-displayName: Contacts - name: Mailboxes x-displayName: Mailboxes - name: Messages x-displayName: Messages - name: Sender Identities x-displayName: Sender Identities - name: Sending Domains x-displayName: Sending Domains - name: Templates x-displayName: Templates - name: Webhooks x-displayName: Webhooks paths: /api/v1/user/contact-imports/{id}/preview: post: tags: - Contacts summary: Preview a contact import description: >- Dry-runs the uploaded file against the proposed mappings and answers with the counts the confirmation step needs. No contacts are written and nothing about the proposal is persisted, so the same draft can be previewed repeatedly with different mappings. `sampleErrors` is capped at the first ten failing rows. Requires the `contacts:write` scope. parameters: - in: header name: X-Organization-Id required: false description: >- Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403. schema: type: string format: uuid - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: type: object properties: fieldMappings: type: array items: type: object properties: csvHeader: type: string minLength: 1 brudcastField: type: string minLength: 1 required: - csvHeader - brudcastField additionalProperties: false minItems: 1 duplicateHandling: enum: - skip - update - create_new allowPartialUpload: type: boolean required: - fieldMappings - duplicateHandling additionalProperties: false responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ContactImportPreviewDataResponse' '401': description: The credential is missing, malformed, revoked or expired content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- The key lacks the scope the endpoint requires, or the organization does not match the credential content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: No such import in the organization content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: The payload or query string failed validation content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '429': description: >- Rate limit exceeded; retry after the number of seconds in `retryAfter` content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorResponse' security: - apiKey: [] - apiKeyBearer: [] components: schemas: ContactImportPreviewDataResponse: type: object properties: success: type: boolean example: true message: type: string data: $ref: '#/components/schemas/ContactImportPreviewData' required: - success - message - data ErrorResponse: type: object properties: success: type: boolean example: false message: type: string example: Resource not found code: type: string enum: - E_VALIDATION_ERROR - E_UNAUTHORIZED_ACCESS - E_UNAUTHORIZED - E_FORBIDDEN - E_INSUFFICIENT_SCOPE - E_ROW_NOT_FOUND - E_TOO_MANY_REQUESTS - E_BUSINESS_RULE_VIOLATION - E_CAMPAIGN_NOT_SENDABLE - INSUFFICIENT_CREDITS - SUBSCRIPTION_REQUIRED example: E_ROW_NOT_FOUND required: - success - message - code ValidationErrorResponse: type: object properties: success: type: boolean example: false message: type: string example: The payload is invalid code: type: string enum: - E_VALIDATION_ERROR - E_UNAUTHORIZED_ACCESS - E_UNAUTHORIZED - E_FORBIDDEN - E_INSUFFICIENT_SCOPE - E_ROW_NOT_FOUND - E_TOO_MANY_REQUESTS - E_BUSINESS_RULE_VIOLATION - E_CAMPAIGN_NOT_SENDABLE - INSUFFICIENT_CREDITS - SUBSCRIPTION_REQUIRED example: E_VALIDATION_ERROR errors: type: array items: $ref: '#/components/schemas/ValidationErrorItem' required: - success - message - code - errors RateLimitErrorResponse: type: object properties: success: type: boolean example: false message: type: string example: Too many requests code: type: string enum: - E_VALIDATION_ERROR - E_UNAUTHORIZED_ACCESS - E_UNAUTHORIZED - E_FORBIDDEN - E_INSUFFICIENT_SCOPE - E_ROW_NOT_FOUND - E_TOO_MANY_REQUESTS - E_BUSINESS_RULE_VIOLATION - E_CAMPAIGN_NOT_SENDABLE - INSUFFICIENT_CREDITS - SUBSCRIPTION_REQUIRED example: E_TOO_MANY_REQUESTS retryAfter: type: number example: 60 required: - success - message - code - retryAfter ContactImportPreviewData: type: object properties: preview: $ref: '#/components/schemas/ContactImportPreview' required: - preview ValidationErrorItem: type: object properties: field: type: string example: emailAddress rule: type: string example: email message: type: string example: The emailAddress field must be a valid email address required: - field - rule - message ContactImportPreview: type: object properties: totalRows: type: number newCount: type: number description: Rows that would create a new contact duplicateCount: type: number description: Rows matching a contact that already exists errorCount: type: number sampleErrors: type: array items: $ref: '#/components/schemas/ContactImportRowError' description: The first ten failing rows, not the complete set required: - totalRows - newCount - duplicateCount - errorCount - sampleErrors ContactImportRowError: type: object properties: row: type: number description: One-based row number in the uploaded file reason: type: string required: - row - reason securitySchemes: apiKey: type: apiKey in: header name: X-API-Key description: >- An organization API key, prefixed `bk_live_`. Takes precedence over `Authorization` when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint. apiKeyBearer: type: http scheme: bearer bearerFormat: bk_live_... description: >- The same organization API key sent as `Authorization: Bearer bk_live_...`. Accepted only when the value begins with `bk_` and no `X-API-Key` header is present. ````