Videos

Import multiple videos into a campaign

Import multiple videos into a campaign with their associated variables and metadata. The lead schema endpoint should be used first to set up the lead schema and mappings.

post/campaigns/{campaignId}/videos/import/v2

Request

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

Path parameters

campaignIdstring required

The unique identifier of the campaign where videos are to be imported

Request body

titleTemplatestring nullable

The template to use for video titles (e.g. "Video for {{first_name}}")

importIdstring nullable

The import ID to group the video under. This is usually the CSV the video was imported from but can be any string to identify a grouping of videos. If not specified, defaults to a random nanoid.

renderTestVideoboolean nullable

If true, the first video in the list will be rendered as a test video. If the campaign does not already have a test video, it will be set to this video. If not specified, the campaign's test video will not be changed and no videos will be automatically queued to render. Has no effect if queueAllVideosForRender is true.

queueAllVideosForRenderboolean nullable

If true, the videos will be queued for rendering. If not specified, the videos will NOT be queued for rendering. Has no effect if renderTestVideo is true.

duplicateIdentifierFieldstring nullable

The field name to use for duplicate detection. If not specified, will use the campaign's default duplicate identifier field.

Response

Videos successfully imported

insertedinteger

Number of videos successfully imported

upsertedinteger

Number of videos successfully updated (if upsert=true)

duplicatesinteger

Number of duplicate entries detected

invalidRowsinteger

Number of rows that failed validation

variableIssuesobject nullable

Details of issues related to specific variables

testVideoQueuedboolean

Whether a test video was queued for rendering

Changes

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