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

# Preview campaign readiness

> Requires `read:campaigns`. Publish readiness without sending — audience size, validation errors, step count.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/marketing/campaigns/{id}/preview
openapi: 3.0.0
info:
  title: Car Storage Software API
  version: 1.1.0
  description: >-
    Team-scoped REST API for Car Storage Software. Authenticate with a team API
    key (`Authorization: Bearer <key>` or `x-api-key: <key>`) created under
    Settings → Integrations → API. Keys carry granular `read:*` / `write:*`
    scopes; read never implies write.
servers:
  - url: https://www.carstoragesoftware.com
security: []
paths:
  /api/v1/marketing/campaigns/{id}/preview:
    get:
      tags:
        - Marketing
      summary: Preview campaign readiness
      description: >-
        Requires `read:campaigns`. Publish readiness without sending — audience
        size, validation errors, step count.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
      responses:
        '200':
          description: Preview campaign readiness
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1CampaignPreviewResponse'
        '401':
          description: Missing, invalid, revoked, or expired API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: API key missing required scope, or API disabled for team.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    V1CampaignPreviewResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/V1CampaignPreview'
      required:
        - data
    ApiError:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        details:
          nullable: true
      required:
        - error
    V1CampaignPreview:
      type: object
      properties:
        canPublish:
          type: boolean
        error:
          type: string
        recipientCount:
          type: integer
        stepCount:
          type: integer
        scheduledAt:
          type: string
          nullable: true
          format: date-time
        channel:
          type: string
          nullable: true
      required:
        - canPublish
        - recipientCount
        - stepCount
        - scheduledAt
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Team API key from Settings → Integrations. Use `Authorization: Bearer
        <key>` or `x-api-key`.

````

## Related topics

- [Resume campaign](/docs/api-reference/marketing/resume-campaign.md)
- [Schedule campaign send](/docs/api-reference/marketing/schedule-campaign-send.md)
- [Add campaign message, audience, and publish](/docs/marketing-events/add-campaign-message-audience-and-publish.md)
- [Create a campaign](/docs/marketing-events/create-a-campaign.md)
- [Create a text, push, or social campaign](/docs/marketing-events/create-a-text-push-or-social-campaign.md)


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