Add prospect to Dynamics Campaign and process video.
curl --request POST \
--url https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-api-secret: <api-key>' \
--data '
{
"prospect": {
"_id": "63f6a4145a5e755e2e8fe19d",
"contactName": "John Doe",
"contactEmail": "johndoe@example.com",
"company": "Example Company",
"jobTitle": "Example jobTitle",
"customField": "Example Custom Field",
"backgroundUrl": "https://example.com",
"originalBackgroundUrl": "https://example.com",
"screenshotUrl": "https://sendspark.com",
"webhookUrl": "https://sendspark.com",
"webhookEvents": [
"video_generated_dv",
"video_watched",
"video_played",
"video_cta_clicked",
"video_viewed",
"video_liked"
],
"audioUrl": "https://sendspark.com",
"valid": false,
"fallbackDataUsed": false,
"fields": {},
"hash": "63f6a4145a5e755e2e8fe19d"
},
"prospectDepurationConfig": {
"forceCreation": false
},
"processAndAuthorizeCharge": false,
"fallbackToEmailDomainForBackground": false,
"callbackId": "63f6a4145a5e755e2e8fe19d"
}
'import requests
url = "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect"
payload = {
"prospect": {
"_id": "63f6a4145a5e755e2e8fe19d",
"contactName": "John Doe",
"contactEmail": "johndoe@example.com",
"company": "Example Company",
"jobTitle": "Example jobTitle",
"customField": "Example Custom Field",
"backgroundUrl": "https://example.com",
"originalBackgroundUrl": "https://example.com",
"screenshotUrl": "https://sendspark.com",
"webhookUrl": "https://sendspark.com",
"webhookEvents": ["video_generated_dv", "video_watched", "video_played", "video_cta_clicked", "video_viewed", "video_liked"],
"audioUrl": "https://sendspark.com",
"valid": False,
"fallbackDataUsed": False,
"fields": {},
"hash": "63f6a4145a5e755e2e8fe19d"
},
"prospectDepurationConfig": { "forceCreation": False },
"processAndAuthorizeCharge": False,
"fallbackToEmailDomainForBackground": False,
"callbackId": "63f6a4145a5e755e2e8fe19d"
}
headers = {
"x-api-key": "<api-key>",
"x-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
prospect: {
_id: '63f6a4145a5e755e2e8fe19d',
contactName: 'John Doe',
contactEmail: 'johndoe@example.com',
company: 'Example Company',
jobTitle: 'Example jobTitle',
customField: 'Example Custom Field',
backgroundUrl: 'https://example.com',
originalBackgroundUrl: 'https://example.com',
screenshotUrl: 'https://sendspark.com',
webhookUrl: 'https://sendspark.com',
webhookEvents: [
'video_generated_dv',
'video_watched',
'video_played',
'video_cta_clicked',
'video_viewed',
'video_liked'
],
audioUrl: 'https://sendspark.com',
valid: false,
fallbackDataUsed: false,
fields: {},
hash: '63f6a4145a5e755e2e8fe19d'
},
prospectDepurationConfig: {forceCreation: false},
processAndAuthorizeCharge: false,
fallbackToEmailDomainForBackground: false,
callbackId: '63f6a4145a5e755e2e8fe19d'
})
};
fetch('https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'prospect' => [
'_id' => '63f6a4145a5e755e2e8fe19d',
'contactName' => 'John Doe',
'contactEmail' => 'johndoe@example.com',
'company' => 'Example Company',
'jobTitle' => 'Example jobTitle',
'customField' => 'Example Custom Field',
'backgroundUrl' => 'https://example.com',
'originalBackgroundUrl' => 'https://example.com',
'screenshotUrl' => 'https://sendspark.com',
'webhookUrl' => 'https://sendspark.com',
'webhookEvents' => [
'video_generated_dv',
'video_watched',
'video_played',
'video_cta_clicked',
'video_viewed',
'video_liked'
],
'audioUrl' => 'https://sendspark.com',
'valid' => false,
'fallbackDataUsed' => false,
'fields' => [
],
'hash' => '63f6a4145a5e755e2e8fe19d'
],
'prospectDepurationConfig' => [
'forceCreation' => false
],
'processAndAuthorizeCharge' => false,
'fallbackToEmailDomainForBackground' => false,
'callbackId' => '63f6a4145a5e755e2e8fe19d'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-api-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect"
payload := strings.NewReader("{\n \"prospect\": {\n \"_id\": \"63f6a4145a5e755e2e8fe19d\",\n \"contactName\": \"John Doe\",\n \"contactEmail\": \"johndoe@example.com\",\n \"company\": \"Example Company\",\n \"jobTitle\": \"Example jobTitle\",\n \"customField\": \"Example Custom Field\",\n \"backgroundUrl\": \"https://example.com\",\n \"originalBackgroundUrl\": \"https://example.com\",\n \"screenshotUrl\": \"https://sendspark.com\",\n \"webhookUrl\": \"https://sendspark.com\",\n \"webhookEvents\": [\n \"video_generated_dv\",\n \"video_watched\",\n \"video_played\",\n \"video_cta_clicked\",\n \"video_viewed\",\n \"video_liked\"\n ],\n \"audioUrl\": \"https://sendspark.com\",\n \"valid\": false,\n \"fallbackDataUsed\": false,\n \"fields\": {},\n \"hash\": \"63f6a4145a5e755e2e8fe19d\"\n },\n \"prospectDepurationConfig\": {\n \"forceCreation\": false\n },\n \"processAndAuthorizeCharge\": false,\n \"fallbackToEmailDomainForBackground\": false,\n \"callbackId\": \"63f6a4145a5e755e2e8fe19d\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect")
.header("x-api-key", "<api-key>")
.header("x-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"prospect\": {\n \"_id\": \"63f6a4145a5e755e2e8fe19d\",\n \"contactName\": \"John Doe\",\n \"contactEmail\": \"johndoe@example.com\",\n \"company\": \"Example Company\",\n \"jobTitle\": \"Example jobTitle\",\n \"customField\": \"Example Custom Field\",\n \"backgroundUrl\": \"https://example.com\",\n \"originalBackgroundUrl\": \"https://example.com\",\n \"screenshotUrl\": \"https://sendspark.com\",\n \"webhookUrl\": \"https://sendspark.com\",\n \"webhookEvents\": [\n \"video_generated_dv\",\n \"video_watched\",\n \"video_played\",\n \"video_cta_clicked\",\n \"video_viewed\",\n \"video_liked\"\n ],\n \"audioUrl\": \"https://sendspark.com\",\n \"valid\": false,\n \"fallbackDataUsed\": false,\n \"fields\": {},\n \"hash\": \"63f6a4145a5e755e2e8fe19d\"\n },\n \"prospectDepurationConfig\": {\n \"forceCreation\": false\n },\n \"processAndAuthorizeCharge\": false,\n \"fallbackToEmailDomainForBackground\": false,\n \"callbackId\": \"63f6a4145a5e755e2e8fe19d\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prospect\": {\n \"_id\": \"63f6a4145a5e755e2e8fe19d\",\n \"contactName\": \"John Doe\",\n \"contactEmail\": \"johndoe@example.com\",\n \"company\": \"Example Company\",\n \"jobTitle\": \"Example jobTitle\",\n \"customField\": \"Example Custom Field\",\n \"backgroundUrl\": \"https://example.com\",\n \"originalBackgroundUrl\": \"https://example.com\",\n \"screenshotUrl\": \"https://sendspark.com\",\n \"webhookUrl\": \"https://sendspark.com\",\n \"webhookEvents\": [\n \"video_generated_dv\",\n \"video_watched\",\n \"video_played\",\n \"video_cta_clicked\",\n \"video_viewed\",\n \"video_liked\"\n ],\n \"audioUrl\": \"https://sendspark.com\",\n \"valid\": false,\n \"fallbackDataUsed\": false,\n \"fields\": {},\n \"hash\": \"63f6a4145a5e755e2e8fe19d\"\n },\n \"prospectDepurationConfig\": {\n \"forceCreation\": false\n },\n \"processAndAuthorizeCharge\": false,\n \"fallbackToEmailDomainForBackground\": false,\n \"callbackId\": \"63f6a4145a5e755e2e8fe19d\"\n}"
response = http.request(request)
puts response.read_body{
"combinedVideo": false,
"dynamicBackground": false,
"status": "pending",
"creator": "okn4ra9qjlpzhs2zpuni426jizysbdcp",
"folder": "ibdls2hjvaebvg0k4mz0zgvndbai9th7",
"workspace": "3vwdfm4jmhfyzt1yqp0r8v3qgaocrczb",
"createdAt": "2021-03-01T00:00:00.000Z",
"name": "My Dynamic Campaign",
"videoProperties": {
"sharePage": {
"title": "Hello there!",
"message": "welcome to my dynamic campaign",
"buttons": [
{
"position": 123,
"label": "<string>",
"link": "http://www.sendspark.com/"
}
],
"calendar": {
"provider": "<string>",
"link": "<string>"
},
"layout": "layout-default",
"transcriptionsViewEnabled": false
}
},
"metadata": {
"version": 1,
"migrated": "2021-03-01T00:00:00.000Z"
},
"videosAssets": [
"<string>"
],
"_id": "63f6a4145a5e755e2e8fe19d",
"deletedAt": null,
"prospectList": [
{
"status": "saved",
"_id": "63f6a4145a5e755e2e8fe19d",
"campaign": "okn4ra9qjl3fs2zpuni426jizysbdcp",
"contactName": "John Doe",
"contactEmail": "johndoe@example.com",
"company": "Example Company",
"jobTitle": "Example jobTitle",
"backgroundUrl": "https://example.com",
"originalBackgroundUrl": "https://example.com",
"screenshotUrl": "https://sendspark.com",
"webhookUrl": "https://sendspark.com",
"trimMuxId": "<string>",
"webhookEvents": [
"video_generated_dv",
"video_watched",
"video_played",
"video_cta_clicked",
"video_viewed",
"video_liked"
],
"webhookPaused": false,
"audioUrl": "https://sendspark.com",
"videoLipSyncUrl": "https://sendspark.com",
"valid": false,
"bulkId": "63f6a4145a5e755e2e8fe19d",
"createdAt": "2023-06-02T00:57:45.447Z",
"updatedAt": "2023-06-02T00:57:45.447Z",
"deletedAt": null,
"validationDetails": "<string>",
"resourcesStatus": {},
"isNotified": false,
"fallback": false,
"regenerationCount": 0,
"fallbackDataUsed": false,
"fields": {},
"hash": "63f6a4145a5e755e2e8fe19d"
}
]
}{
"statusCode": 400,
"code": "S400-AHVE",
"error": "Bad Request",
"message": "Invalid request payload input"
}{
"statusCode": 403,
"code": "S403-UPLD",
"error": "Forbidden",
"message": "Invalid request payload input / Any error from provider"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found or invalid access"
}{
"statusCode": 503,
"error": "Service Unavailable",
"message": "Service Unavailable"
}Dynamics Campaign
Add prospect to Dynamics Campaign and process video.
API Gateway only.
POST
/
v1
/
workspaces
/
{workspaceId}
/
dynamics
/
{dynamicsId}
/
prospect
Add prospect to Dynamics Campaign and process video.
curl --request POST \
--url https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-api-secret: <api-key>' \
--data '
{
"prospect": {
"_id": "63f6a4145a5e755e2e8fe19d",
"contactName": "John Doe",
"contactEmail": "johndoe@example.com",
"company": "Example Company",
"jobTitle": "Example jobTitle",
"customField": "Example Custom Field",
"backgroundUrl": "https://example.com",
"originalBackgroundUrl": "https://example.com",
"screenshotUrl": "https://sendspark.com",
"webhookUrl": "https://sendspark.com",
"webhookEvents": [
"video_generated_dv",
"video_watched",
"video_played",
"video_cta_clicked",
"video_viewed",
"video_liked"
],
"audioUrl": "https://sendspark.com",
"valid": false,
"fallbackDataUsed": false,
"fields": {},
"hash": "63f6a4145a5e755e2e8fe19d"
},
"prospectDepurationConfig": {
"forceCreation": false
},
"processAndAuthorizeCharge": false,
"fallbackToEmailDomainForBackground": false,
"callbackId": "63f6a4145a5e755e2e8fe19d"
}
'import requests
url = "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect"
payload = {
"prospect": {
"_id": "63f6a4145a5e755e2e8fe19d",
"contactName": "John Doe",
"contactEmail": "johndoe@example.com",
"company": "Example Company",
"jobTitle": "Example jobTitle",
"customField": "Example Custom Field",
"backgroundUrl": "https://example.com",
"originalBackgroundUrl": "https://example.com",
"screenshotUrl": "https://sendspark.com",
"webhookUrl": "https://sendspark.com",
"webhookEvents": ["video_generated_dv", "video_watched", "video_played", "video_cta_clicked", "video_viewed", "video_liked"],
"audioUrl": "https://sendspark.com",
"valid": False,
"fallbackDataUsed": False,
"fields": {},
"hash": "63f6a4145a5e755e2e8fe19d"
},
"prospectDepurationConfig": { "forceCreation": False },
"processAndAuthorizeCharge": False,
"fallbackToEmailDomainForBackground": False,
"callbackId": "63f6a4145a5e755e2e8fe19d"
}
headers = {
"x-api-key": "<api-key>",
"x-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
prospect: {
_id: '63f6a4145a5e755e2e8fe19d',
contactName: 'John Doe',
contactEmail: 'johndoe@example.com',
company: 'Example Company',
jobTitle: 'Example jobTitle',
customField: 'Example Custom Field',
backgroundUrl: 'https://example.com',
originalBackgroundUrl: 'https://example.com',
screenshotUrl: 'https://sendspark.com',
webhookUrl: 'https://sendspark.com',
webhookEvents: [
'video_generated_dv',
'video_watched',
'video_played',
'video_cta_clicked',
'video_viewed',
'video_liked'
],
audioUrl: 'https://sendspark.com',
valid: false,
fallbackDataUsed: false,
fields: {},
hash: '63f6a4145a5e755e2e8fe19d'
},
prospectDepurationConfig: {forceCreation: false},
processAndAuthorizeCharge: false,
fallbackToEmailDomainForBackground: false,
callbackId: '63f6a4145a5e755e2e8fe19d'
})
};
fetch('https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'prospect' => [
'_id' => '63f6a4145a5e755e2e8fe19d',
'contactName' => 'John Doe',
'contactEmail' => 'johndoe@example.com',
'company' => 'Example Company',
'jobTitle' => 'Example jobTitle',
'customField' => 'Example Custom Field',
'backgroundUrl' => 'https://example.com',
'originalBackgroundUrl' => 'https://example.com',
'screenshotUrl' => 'https://sendspark.com',
'webhookUrl' => 'https://sendspark.com',
'webhookEvents' => [
'video_generated_dv',
'video_watched',
'video_played',
'video_cta_clicked',
'video_viewed',
'video_liked'
],
'audioUrl' => 'https://sendspark.com',
'valid' => false,
'fallbackDataUsed' => false,
'fields' => [
],
'hash' => '63f6a4145a5e755e2e8fe19d'
],
'prospectDepurationConfig' => [
'forceCreation' => false
],
'processAndAuthorizeCharge' => false,
'fallbackToEmailDomainForBackground' => false,
'callbackId' => '63f6a4145a5e755e2e8fe19d'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-api-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect"
payload := strings.NewReader("{\n \"prospect\": {\n \"_id\": \"63f6a4145a5e755e2e8fe19d\",\n \"contactName\": \"John Doe\",\n \"contactEmail\": \"johndoe@example.com\",\n \"company\": \"Example Company\",\n \"jobTitle\": \"Example jobTitle\",\n \"customField\": \"Example Custom Field\",\n \"backgroundUrl\": \"https://example.com\",\n \"originalBackgroundUrl\": \"https://example.com\",\n \"screenshotUrl\": \"https://sendspark.com\",\n \"webhookUrl\": \"https://sendspark.com\",\n \"webhookEvents\": [\n \"video_generated_dv\",\n \"video_watched\",\n \"video_played\",\n \"video_cta_clicked\",\n \"video_viewed\",\n \"video_liked\"\n ],\n \"audioUrl\": \"https://sendspark.com\",\n \"valid\": false,\n \"fallbackDataUsed\": false,\n \"fields\": {},\n \"hash\": \"63f6a4145a5e755e2e8fe19d\"\n },\n \"prospectDepurationConfig\": {\n \"forceCreation\": false\n },\n \"processAndAuthorizeCharge\": false,\n \"fallbackToEmailDomainForBackground\": false,\n \"callbackId\": \"63f6a4145a5e755e2e8fe19d\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect")
.header("x-api-key", "<api-key>")
.header("x-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"prospect\": {\n \"_id\": \"63f6a4145a5e755e2e8fe19d\",\n \"contactName\": \"John Doe\",\n \"contactEmail\": \"johndoe@example.com\",\n \"company\": \"Example Company\",\n \"jobTitle\": \"Example jobTitle\",\n \"customField\": \"Example Custom Field\",\n \"backgroundUrl\": \"https://example.com\",\n \"originalBackgroundUrl\": \"https://example.com\",\n \"screenshotUrl\": \"https://sendspark.com\",\n \"webhookUrl\": \"https://sendspark.com\",\n \"webhookEvents\": [\n \"video_generated_dv\",\n \"video_watched\",\n \"video_played\",\n \"video_cta_clicked\",\n \"video_viewed\",\n \"video_liked\"\n ],\n \"audioUrl\": \"https://sendspark.com\",\n \"valid\": false,\n \"fallbackDataUsed\": false,\n \"fields\": {},\n \"hash\": \"63f6a4145a5e755e2e8fe19d\"\n },\n \"prospectDepurationConfig\": {\n \"forceCreation\": false\n },\n \"processAndAuthorizeCharge\": false,\n \"fallbackToEmailDomainForBackground\": false,\n \"callbackId\": \"63f6a4145a5e755e2e8fe19d\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prospect\": {\n \"_id\": \"63f6a4145a5e755e2e8fe19d\",\n \"contactName\": \"John Doe\",\n \"contactEmail\": \"johndoe@example.com\",\n \"company\": \"Example Company\",\n \"jobTitle\": \"Example jobTitle\",\n \"customField\": \"Example Custom Field\",\n \"backgroundUrl\": \"https://example.com\",\n \"originalBackgroundUrl\": \"https://example.com\",\n \"screenshotUrl\": \"https://sendspark.com\",\n \"webhookUrl\": \"https://sendspark.com\",\n \"webhookEvents\": [\n \"video_generated_dv\",\n \"video_watched\",\n \"video_played\",\n \"video_cta_clicked\",\n \"video_viewed\",\n \"video_liked\"\n ],\n \"audioUrl\": \"https://sendspark.com\",\n \"valid\": false,\n \"fallbackDataUsed\": false,\n \"fields\": {},\n \"hash\": \"63f6a4145a5e755e2e8fe19d\"\n },\n \"prospectDepurationConfig\": {\n \"forceCreation\": false\n },\n \"processAndAuthorizeCharge\": false,\n \"fallbackToEmailDomainForBackground\": false,\n \"callbackId\": \"63f6a4145a5e755e2e8fe19d\"\n}"
response = http.request(request)
puts response.read_body{
"combinedVideo": false,
"dynamicBackground": false,
"status": "pending",
"creator": "okn4ra9qjlpzhs2zpuni426jizysbdcp",
"folder": "ibdls2hjvaebvg0k4mz0zgvndbai9th7",
"workspace": "3vwdfm4jmhfyzt1yqp0r8v3qgaocrczb",
"createdAt": "2021-03-01T00:00:00.000Z",
"name": "My Dynamic Campaign",
"videoProperties": {
"sharePage": {
"title": "Hello there!",
"message": "welcome to my dynamic campaign",
"buttons": [
{
"position": 123,
"label": "<string>",
"link": "http://www.sendspark.com/"
}
],
"calendar": {
"provider": "<string>",
"link": "<string>"
},
"layout": "layout-default",
"transcriptionsViewEnabled": false
}
},
"metadata": {
"version": 1,
"migrated": "2021-03-01T00:00:00.000Z"
},
"videosAssets": [
"<string>"
],
"_id": "63f6a4145a5e755e2e8fe19d",
"deletedAt": null,
"prospectList": [
{
"status": "saved",
"_id": "63f6a4145a5e755e2e8fe19d",
"campaign": "okn4ra9qjl3fs2zpuni426jizysbdcp",
"contactName": "John Doe",
"contactEmail": "johndoe@example.com",
"company": "Example Company",
"jobTitle": "Example jobTitle",
"backgroundUrl": "https://example.com",
"originalBackgroundUrl": "https://example.com",
"screenshotUrl": "https://sendspark.com",
"webhookUrl": "https://sendspark.com",
"trimMuxId": "<string>",
"webhookEvents": [
"video_generated_dv",
"video_watched",
"video_played",
"video_cta_clicked",
"video_viewed",
"video_liked"
],
"webhookPaused": false,
"audioUrl": "https://sendspark.com",
"videoLipSyncUrl": "https://sendspark.com",
"valid": false,
"bulkId": "63f6a4145a5e755e2e8fe19d",
"createdAt": "2023-06-02T00:57:45.447Z",
"updatedAt": "2023-06-02T00:57:45.447Z",
"deletedAt": null,
"validationDetails": "<string>",
"resourcesStatus": {},
"isNotified": false,
"fallback": false,
"regenerationCount": 0,
"fallbackDataUsed": false,
"fields": {},
"hash": "63f6a4145a5e755e2e8fe19d"
}
]
}{
"statusCode": 400,
"code": "S400-AHVE",
"error": "Bad Request",
"message": "Invalid request payload input"
}{
"statusCode": 403,
"code": "S403-UPLD",
"error": "Forbidden",
"message": "Invalid request payload input / Any error from provider"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found or invalid access"
}{
"statusCode": 503,
"error": "Service Unavailable",
"message": "Service Unavailable"
}Body
application/json
Response
Successful
Example:
false
Example:
false
Example:
"pending"
Example:
"okn4ra9qjlpzhs2zpuni426jizysbdcp"
Example:
"ibdls2hjvaebvg0k4mz0zgvndbai9th7"
Example:
"3vwdfm4jmhfyzt1yqp0r8v3qgaocrczb"
Example:
"2021-03-01T00:00:00.000Z"
Example:
"My Dynamic Campaign"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"63f6a4145a5e755e2e8fe19d"
For managing soft deletes
Example:
null
Show child attributes
Show child attributes
Was this page helpful?
Generate videos for Dynamics Campaign prospect listBulk add and process prospects to a dynamics campaign.
⌘I