Create

post

https://api.beyondwords.io/v1/projects/{project_id}/ads

Creates an ad in a project

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

project_id

string

required

The numeric ID of your project

Body Params

Create ad with custom type

type

string

enum

Defaults to custom

The type of ad, either custom or vast. Ads of type custom must have title, url and media fields. Ads of type vast must have title and vast_url fields.

Allowed:

placement

string

enum

Whether the ad should play before/during/after the audio content. Possible values are pre-roll, mid-roll, or post-roll

Allowed:

title

string | null

The title of the ad

click_through_url

string | null

The click-through URL of the custom ad to show in the player

image_url

string | null

The image URL to show in the player while the ad is playing

audio_url

string | null

The URL of the audio file of the custom ad to play in the player

video_url

string | null

The URL of the video file of the custom ad to play in the player

theme

string | null

enum

The color theme to use for the ad when it is playing. Possible values are auto, dark,light The autoß theme is based on the user's light/dark mode system preference.

Allowed:

dark_theme

object | null

The dark theme colors

light_theme

object | null

The light theme colors

video_theme

object | null

The video theme colors

time_range

object | null

The time range for when the ad should play in the player

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201successful