SEsendspark
Dynamics Campaign

Create Dynamics Campaign for the DV by steps UI

Changed on

Create Dynamics Campaign in folder for the DV by steps UI

post/v2/workspaces/{workspaceId}/dynamics

Request

  • Base URL
    https://api-gw.sendspark.com
  • Auth
    API key in header x-api-key and API key in header x-api-secret

Path parameters

workspaceIdstring required

Request body

namestring required
voiceCloningboolean
languageCodestring
videoUrlstring
versionnumber
multivariableboolean

Example request

{
  "name": "My Dynamic Campaign",
  "languageCode": "en",
  "videoUrl": "https://ssoven341-d3vz.com/share/9up29v11k16cqtyie1hx74cmhva5yutz",
  "version": 1
}

Response

Successful

namestring
languageCodestring
combinedVideoboolean required
dynamicBackgroundboolean required
statusstring required
creatorstring required
folderstring required
workspacestring required
videosAssetsstring[]
idstring required
createdAtstring date required

Example response

{
  "name": "My Dynamic Campaign",
  "languageCode": "en",
  "videoProperties": {
    "sharePage": {
      "title": "Hello there!",
      "message": "welcome to my dynamic campaign",
      "layout": "layout-default"
    }
  },
  "metadata": {
    "version": 1,
    "migrated": "2021-03-01T00:00:00.000Z"
  },
  "status": "pending",
  "creator": "okn4ra9qjlpzhs2zpuni426jizysbdcp",
  "folder": "ibdls2hjvaebvg0k4mz0zgvndbai9th7",
  "workspace": "3vwdfm4jmhfyzt1yqp0r8v3qgaocrczb",
  "id": "63f6a4145a5e755e2e8fe19d",
  "createdAt": "2021-03-01T00:00:00.000Z"
}

Changes