Videos

Create (or Update) a video in a Campaign

post/campaigns/{campaignId}/videos

Request

  • Base URL: https://api.pitchlane.com/api/public/v1
  • URL: https://api.pitchlane.com/api/public/v1/campaigns/{campaignId}/videos
  • Auth: API key in header X-API-Key

Path parameters

campaignIdstring required

The unique identifier of the campaign

Request body

queueForRenderboolean

If true, the video will automatically be added to the rendering queue to be rendered (default). If false, the video will be created in Pitchlane but will not be rendered until the "Render all Videos" button is pressed in the Pitchlane UI.

titlestring nullable

The title of the video to create. If not specified, the title will be generated following the campaign's titleTemplate.

Response

Video created successfully

idstring

The full ID of the video created.

shortIdstring

The short ID of the video created (used in the final video URL).

Example response

{
  "id": "DHFG2C09n_3qrsSymZjjm",
  "shortId": "3qrsSymZjjm"
}

Changes

No recorded changes to this operation across all 1 revision of this API.