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

# Add a CTA

> Adds a call to action button that appears over the video between the given start and end times.

<Info>Replace `{your-subdomain}` with your workspace's subdomain. <br /> Learn how to find your subdomain in [Workspace subdomain](/getting-started/workspace-subdomain).</Info>


## OpenAPI

````yaml bundled/recordings.yaml POST /recordings/{id}/ctas
openapi: 3.0.3
info:
  title: NeetoRecord Recordings APIs
  version: 2.0.0
servers:
  - description: NeetoRecord APIs
    url: https://{your-subdomain}.neetorecord.com/api/external/v2
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/getting-started/workspace-subdomain).
security: []
tags:
  - name: Recordings
    description: APIs to retrieve and manage recordings in your workspace.
paths:
  /recordings/{id}/ctas:
    post:
      tags:
        - Recordings
      summary: Add a CTA
      description: >-
        Adds a call to action button that appears over the video between the
        given start and end times.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
        - $ref: '#/components/parameters/accept_header'
        - $ref: '#/components/parameters/recording_id_param'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - cta
              properties:
                cta:
                  type: object
                  required:
                    - label
                    - start
                    - end
                  properties:
                    label:
                      type: string
                      description: Text shown on the button.
                      example: Book a demo
                    link:
                      type: string
                      description: URL the button opens.
                      example: https://your-workspace.neetocal.com/meeting-with-oliver
                    start:
                      type: number
                      description: Time in seconds at which the button appears.
                      example: 30
                    end:
                      type: number
                      description: Time in seconds at which the button disappears.
                      example: 90
                    position:
                      type: string
                      enum:
                        - top-right
                        - top-left
                        - bottom-right
                        - bottom-left
                      default: top-right
                      description: Corner of the player the button is anchored to.
                    background_color:
                      type: string
                      default: '#000000'
                      description: Button background color, as a hex string.
                      example: '#000000'
                    text_color:
                      type: string
                      default: '#FFFFFF'
                      description: Button text color, as a hex string.
                      example: '#FFFFFF'
                    show_only_at_end:
                      type: boolean
                      default: false
                      description: Show the button only after the recording finishes.
      responses:
        '200':
          description: The CTA was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cta_create_response'
              example:
                id: c47e2f81-6a90-4b3d-8e21-5f0c9d7b1a63
                recording_id: x9y8z7w6v5u4t3s2
                label: Book a demo
                link: https://your-workspace.neetocal.com/meeting-with-oliver
                start: 30
                end: 90
                position: top-right
                background_color: '#000000'
                text_color: '#FFFFFF'
                show_only_at_end: false
        '404':
          $ref: '#/components/responses/recording_not_found'
        '422':
          description: >-
            The request body is missing the `cta` key, or a required attribute
            is absent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
              example:
                error: 'param is missing or the value is empty or invalid: cta'
components:
  parameters:
    api_key_header:
      in: header
      name: X-Api-Key
      description: >-
        API key. Refer to [Authentication](/getting-started/authentication) for
        more information.
      required: true
      schema:
        type: string
    accept_header:
      in: header
      name: Accept
      description: Must be `application/json`.
      required: true
      schema:
        type: string
        enum:
          - application/json
        default: application/json
    recording_id_param:
      in: path
      name: id
      required: true
      description: >-
        The recording's `id` (UUID) or its `public_link_id` (the short code in
        the watch URL). Both are accepted.
      schema:
        type: string
  schemas:
    cta_create_response:
      allOf:
        - $ref: '#/components/schemas/cta'
        - type: object
          properties:
            recording_id:
              type: string
              description: Public link identifier of the recording.
            background_color:
              type: string
              description: Button background color, as a hex string.
            text_color:
              type: string
              description: Button text color, as a hex string.
    error:
      type: object
      properties:
        error:
          type: string
          description: A human readable error message.
    cta:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the CTA.
        label:
          type: string
          description: Text shown on the button.
        link:
          type: string
          nullable: true
          description: URL the button opens.
        start:
          type: number
          description: Time in seconds at which the button appears.
        end:
          type: number
          description: Time in seconds at which the button disappears.
        position:
          type: string
          enum:
            - top-right
            - top-left
            - bottom-right
            - bottom-left
          description: Corner of the player the button is anchored to.
        show_only_at_end:
          type: boolean
          description: Whether the button is shown only after the recording finishes.
  responses:
    recording_not_found:
      description: The recording does not exist in this workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          example:
            error: Recording does not exist.

````