---
title: "Preview Organization"
method: POST
path: "/admin/crm/maintenance-optout-migrations/organization/preview"
tags: ["admin", "crm"]
---

# Preview Organization

`POST /admin/crm/maintenance-optout-migrations/organization/preview`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/admin/crm/maintenance-optout-migrations/organization/preview`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Headers

- `organization-id` string, nullable
- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Request body

- PreviewOrganizationOptoutsRequest
  - `organization_id` string, required
  - `mappings` CampaignMaintenanceMapping[], required
    - `campaign_id` string, required
    - `maintenance_type_id` string, required
  - `after_source_id` string, nullable
  - `limit` integer

## Response `200`

Successful Response

- OrganizationOptoutPreview
  - `organization_id` string, required
  - `mappings` CampaignMaintenanceMapping[], required
    - `campaign_id` string, required
    - `maintenance_type_id` string, required
  - `total_active_source_records` integer, required
  - `items` CampaignOptoutMappingItem[], required
    - `source_request_id` string, required
    - `contact_id` string, required
    - `customer_id` integer, nullable, required
    - `campaign_id` string, required
    - `maintenance_type_id` string, required
    - `maintenance_name` string, required
    - `expires_at` string, date-time, nullable, required
    - `status` 'ready' | 'already_mapped' | 'blocked', required
    - `blocker` string, nullable
    - `replacement_request_id` string, nullable
    - `replacement_expires_at` string, date-time, nullable
    - `replacement_is_active` boolean, nullable
  - `ready_source_request_ids` string[], required
  - `review_sha256` string, nullable, required
  - `next_after_source_id` string, nullable, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/cce8b07a5787?raw)