POST https://api.vidyard.com/dashboard/v1/campaigns/video
Create an AI video for a new campaign

Create an AI video for campaign - POC for Vidyard

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
POST /v1/campaigns/video
Content-Type: application/json

BODY
{
  "campaign": {
    "campaign_id": "foo-bar"
  },
  "webhook_url": "http://foo.bar/video/created",
  "lead_owner": {
    "email": "ricky@something.com"
  },
  "lead_info": {
    "info": [
      ["key1", "val1"],
      ["key2", "val2"]
    ]
  },
  "integration": "hubspot"
}

RESPONSE
201 Created
{
  "job_id": 1234
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
campaign
required

Campaign within which video will be created

Validations:

  • Must be a Hash
campaign[campaign_id]
required

UUID identifying campaign

Validations:

  • Must be a String
webhook_url
optional

URL to call when video is created, player UUID will be provided in the body

Validations:

  • Must be a String
lead_owner
required

Owner of the lead, refers to an account within organization running the campaign

Validations:

  • Must be a Hash
lead_owner[email]
required

Lead owner email

Validations:

  • Must be a String
lead_info
required

Lead info container

Validations:

  • Must be a Hash
lead_info[info]
required

Lead info key/value pairs

Validations:

  • Must be an array of any type
integration
optional

Integration name (e.g., hubspot, salesforce)

Validations:

  • Must be a String