---
title: "Add prospect to Dynamics Campaign and process video."
method: POST
path: "/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect"
tags: ["Dynamics Campaign"]
---

# Add prospect to Dynamics Campaign and process video.

`POST /v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect`

## Request

- Base URL: `https://api-gw.sendspark.com`
- URL: `https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect`
- Auth: API key in header `x-api-key` and API key in header `x-api-secret`

API Gateway only.

## Path parameters

- `workspaceId` string, required
- `dynamicsId` string, required

## Request body

- RequestPayloadAddProspectsDynamicsCampaignsSchema
  - `prospect` RequestPayloadProspectSchema, required
    - `_id` string
    - `contactName` string
    - `contactEmail` string: Must be unique for each dynamics videos campaign
    - `company` string
    - `jobTitle` string
    - `customField` string
    - `backgroundUrl` string
    - `originalBackgroundUrl` string
    - `screenshotUrl` string
    - `webhookUrl` string
    - `webhookEvents` string[]
    - `audioUrl` string
    - `valid` boolean
    - `fallbackDataUsed` boolean
    - `fields` Fields
    - `hash` string
  - `prospectDepurationConfig` ProspectDepurationConfig
    - `forceCreation` boolean
    - `payloadDepurationStrategy` 'keep-first-valid' | 'keep-last-valid'
  - `processAndAuthorizeCharge` boolean
  - `fallbackToEmailDomainForBackground` boolean
  - `callbackId` string

## Response `200`

Successful

- ResponseModifyDynamicsCampaignSchema
  - `name` string
  - `videoProperties` VideoProperties
    - `sharePage` SharePage
      - `title` string
      - `message` string
      - `buttons` Model169[]
        - `position` number
        - `label` string
        - `link` string
      - `calendar` Model170
        - `provider` string
        - `link` string
      - `layout` 'layout-default' | 'layout-title-above'
      - `transcriptionsViewEnabled` boolean
  - `metadata` Metadata
    - `version` number
    - `migrated` string, date
  - `combinedVideo` boolean, required
  - `dynamicBackground` boolean, required
  - `status` string, required
  - `creator` string, required
  - `folder` string, required
  - `workspace` string, required
  - `videosAssets` string[]
  - `_id` string
  - `createdAt` string, date, required
  - `deletedAt` string, date: For managing soft deletes
  - `prospectList` ResponsePayloadProspectSchema[]
    - `_id` string
    - `campaign` string
    - `contactName` string
    - `contactEmail` string: Must be unique for each dynamics videos campaign
    - `company` string
    - `jobTitle` string
    - `backgroundUrl` string
    - `originalBackgroundUrl` string
    - `screenshotUrl` string
    - `webhookUrl` string
    - `trimMuxId` string
    - `webhookEvents` string[]
    - `webhookPaused` boolean
    - `audioUrl` string
    - `videoLipSyncUrl` string
    - `valid` boolean
    - `bulkId` string
    - `status` string, required: Manage constants for this
    - `createdAt` string, date
    - `updatedAt` string, date
    - `deletedAt` string, date: For managing soft deletes
    - `validationDetails` string
    - `resourcesStatus` ResourcesStatus
    - `isNotified` boolean
    - `fallback` boolean
    - `regenerationCount` number
    - `fallbackDataUsed` boolean
    - `fields` Fields
    - `hash` string

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `503`: Service Unavailable

## Changes

- **2026-07-15** `781b5762fe77`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sendspark/apis/sendspark-api/changes/v1/workspaces/:workspaceId/dynamics/:dynamicsId/prospect/post.md)

---

[API](https://skmtc.dev/sendspark/apis/sendspark-api.md) - [All operations](https://skmtc.dev/sendspark/apis/sendspark-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sendspark/apis/sendspark-api/revisions/d8d365944ae5?raw)