Skip to main content
POST
Add a CTA
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
required

API key. Refer to Authentication for more information.

Accept
enum<string>
default:application/json
required

Must be application/json.

Available options:
application/json

Path Parameters

id
string
required

The recording's id (UUID) or its public_link_id (the short code in the watch URL). Both are accepted.

Body

application/json
cta
object
required

Response

The CTA was created.

id
string<uuid>

Unique identifier for the CTA.

label
string

Text shown on the button.

URL the button opens.

start
number

Time in seconds at which the button appears.

end
number

Time in seconds at which the button disappears.

position
enum<string>

Corner of the player the button is anchored to.

Available options:
top-right,
top-left,
bottom-right,
bottom-left
show_only_at_end
boolean

Whether the button is shown only after the recording finishes.

recording_id
string

Public link identifier of the recording.

background_color
string

Button background color, as a hex string.

text_color
string

Button text color, as a hex string.