Skip to main content
PATCH
Persisting Prospect Lists

Authorizations

x-api-key
string
header
required
x-api-secret
string
header
required

Path Parameters

workspaceId
string
required
dynamicsId
string
required

Body

application/json
videoUrl
string
Example:

"https://stg341.sendspark.com/share/i5hu8v1ctjt5surn"

name
string
Example:

"My Dynamic Campaign"

title
string
Example:

"Hello there!"

message
string
Example:

"welcome to my dynamic campaign"

buttons
object[]
calendar
object
prospectList
object[]
Required array length: 1 - 10000 elements
voiceCloning
object
prospectDepurationConfig
object
processAndAuthorizeCharge
boolean
Example:

false

callbackId
string
Example:

"63f6a4145a5e755e2e8fe19d"

fields
object

Response

Successful

combinedVideo
boolean
required
Example:

false

dynamicBackground
boolean
required
Example:

false

status
string
required
Example:

"pending"

creator
string
required
Example:

"okn4ra9qjlpzhs2zpuni426jizysbdcp"

folder
string
required
Example:

"ibdls2hjvaebvg0k4mz0zgvndbai9th7"

workspace
string
required
Example:

"3vwdfm4jmhfyzt1yqp0r8v3qgaocrczb"

createdAt
string<date>
required
Example:

"2021-03-01T00:00:00.000Z"

name
string
Example:

"My Dynamic Campaign"

videoProperties
object
metadata
object
videosAssets
string[]
_id
string
Example:

"63f6a4145a5e755e2e8fe19d"

deletedAt
string<date>

For managing soft deletes

Example:

null

prospectList
object[]