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

# Replace a video's CTA cards

> Replaces the video's entire CTA card list: the timed, clickable cards that appear over the player. This is a full replace, not a merge: send every card you want to keep. An empty `cards` array turns CTA cards off. Recompiles the player.

Requires a token with the `videos:write` scope.



## OpenAPI

````yaml /api-reference/openapi.json post /videos/{video}/cta-cards
openapi: 3.1.0
info:
  title: TrackPlay API
  description: >-
    Send conversions and events to TrackPlay, and read them back. Authenticated
    with scoped tokens you mint in the dashboard.
  version: 1.0.0
servers:
  - url: https://app.trackplay.io/api/v1
    description: App API. Conversions, videos, webhooks.
  - url: https://e.trackplay.io
    description: Events API. High-volume event ingest.
security:
  - bearerAuth: []
tags:
  - name: Videos
    description: Create, read, update, and delete videos, and read workspace metadata.
  - name: Video settings
    description: Save a settings draft, publish it live, and read or restore past deploys.
  - name: Uploads
    description: >-
      Upload a source video file in one request or in resumable chunks, and poll
      its processing status.
  - name: Captions and chapters
    description: >-
      Manage caption tracks, chapter markers, AI-generated segments, and CTA
      cards on a video.
  - name: Playlists
    description: Group videos into a playlist or course, and manage the videos inside it.
  - name: Webhooks
    description: Subscribe a URL to TrackPlay lifecycle events and test deliveries.
  - name: Zapier
    description: >-
      The REST-hook endpoints Zapier calls to connect a workspace and manage
      triggers.
  - name: Analytics
    description: Read play, retention, event, and conversion analytics for a video.
  - name: Exports
    description: Queue and download bulk analytics exports.
  - name: Conversions
    description: Report a sale or a lead, from your own server or from a browser fallback.
  - name: Events
    description: Send a custom event tied to a viewer's session.
  - name: Identity
    description: Resolve a viewer's identity from the page, with no token required.
paths:
  /videos/{video}/cta-cards:
    post:
      tags:
        - Captions and chapters
      summary: Replace a video's CTA cards
      description: >-
        Replaces the video's entire CTA card list: the timed, clickable cards
        that appear over the player. This is a full replace, not a merge: send
        every card you want to keep. An empty `cards` array turns CTA cards off.
        Recompiles the player.


        Requires a token with the `videos:write` scope.
      operationId: putVideoCtaCards
      parameters:
        - name: video
          in: path
          required: true
          schema:
            type: integer
          description: The video's numeric ID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CtaCardsRequest'
      responses:
        '200':
          description: The video's CTA cards.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CtaCardsResponse'
        '401':
          description: >-
            `AUTH_REQUIRED`: no token sent. `INVALID_TOKEN`: the token is
            invalid, expired, or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: '`INSUFFICIENT_SCOPE`: the token does not carry `videos:write`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: No video with that ID exists in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LaravelNotFoundError'
        '422':
          description: Validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '429':
          description: Rate limited. 60 requests per minute per token.
components:
  schemas:
    CtaCardsRequest:
      type: object
      required:
        - cards
      properties:
        cards:
          type: array
          items:
            $ref: '#/components/schemas/CtaCardItem'
          description: >-
            The complete card list. This is a full replace: send every card you
            want to keep.
        enabled:
          type: boolean
          description: >-
            Turns CTA cards on or off in the player. Defaults to true when
            `cards` is non-empty, false otherwise.
    CtaCardsResponse:
      type: object
      properties:
        cta_cards_options:
          type: object
          properties:
            cards:
              type: array
              items:
                $ref: '#/components/schemas/CtaCardItem'
            enabled:
              type: boolean
    ApiError:
      type: object
      description: The error shape the app API returns on a failed read or export.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                A stable error code, e.g. `INSUFFICIENT_SCOPE`,
                `VIDEO_NOT_FOUND`, `EXPORT_NOT_FOUND`.
            message:
              type: string
              description: What went wrong, in plain English.
    LaravelNotFoundError:
      type: object
      description: >-
        The default not-found body Laravel returns when a route model lookup
        fails (`findOrFail`). It carries no stable error code, unlike the app's
        own `{"error": {"code": ...}}` shape used on hand-written error paths in
        this API.
      properties:
        message:
          type: string
          examples:
            - No query results for model [App\\Models\\WorkspaceVideo] 481
    ValidationError:
      type: object
      description: >-
        Laravel's default validation-failure body. `errors` maps each invalid
        field to its list of messages.
      properties:
        message:
          type: string
          examples:
            - The given data was invalid.
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    CtaCardItem:
      type: object
      required:
        - time
      properties:
        time:
          type: integer
          minimum: 0
          description: When the card appears, in seconds from the start of the video.
        duration_s:
          type: integer
          minimum: 1
          maximum: 120
          description: How long the card stays on screen, in seconds.
        headline:
          type: string
          maxLength: 255
        body:
          type: string
          maxLength: 2048
        button_text:
          type: string
          maxLength: 128
        url:
          type: string
          format: uri
          maxLength: 2048
          description: Where the button sends the viewer.
        button_color:
          type: string
          maxLength: 32
        stripe_price_id:
          type: string
          maxLength: 128
          description: >-
            Attaches a Stripe price to the card's button for an in-player
            checkout.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A scoped token minted in **Settings → API tokens**. Send it as
        `Authorization: Bearer tplt_…` or `X-API-Key: tplt_…`.

````

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