SEsendspark
Dynamics Campaign

Add prospect to Dynamics Campaign and process video.

Changed on

API Gateway only.

post/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect

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
dynamicsIdstring required

Request body

processAndAuthorizeChargeboolean
fallbackToEmailDomainForBackgroundboolean
callbackIdstring

Example request

{
  "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",
    "hash": "63f6a4145a5e755e2e8fe19d"
  },
  "callbackId": "63f6a4145a5e755e2e8fe19d"
}

Response

Successful

namestring
combinedVideoboolean required
dynamicBackgroundboolean required
statusstring required
creatorstring required
folderstring required
workspacestring required
videosAssetsstring[]
_idstring
createdAtstring date required
deletedAtstring date

For managing soft deletes

Example response

{
  "name": "My Dynamic Campaign",
  "videoProperties": {
    "sharePage": {
      "title": "Hello there!",
      "message": "welcome to my dynamic campaign",
      "buttons": [
        {
          "link": "http://www.sendspark.com/"
        }
      ],
      "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",
  "prospectList": [
    {
      "_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",
      "webhookEvents": [
        "video_generated_dv",
        "video_watched",
        "video_played",
        "video_cta_clicked",
        "video_viewed",
        "video_liked"
      ],
      "audioUrl": "https://sendspark.com",
      "videoLipSyncUrl": "https://sendspark.com",
      "bulkId": "63f6a4145a5e755e2e8fe19d",
      "status": "saved",
      "createdAt": "2023-06-02T00:57:45.447Z",
      "updatedAt": "2023-06-02T00:57:45.447Z",
      "hash": "63f6a4145a5e755e2e8fe19d"
    }
  ]
}

Changes