How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Sendspark Dynamics Campaign API

The Dynamics Campaign API from Sendspark — 12 operation(s) for dynamics campaign.

Sendspark Dynamics Campaign API is one of 4 APIs that Sendspark publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Dynamics Campaign. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and an AsyncAPI specification.

This API exposes 13 operations across 12 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version 1.2.0.

Requests are made against a single base URL, https://api-gw.sendspark.com.

13 operations 12 paths 56 schemas 4 GET3 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.2.0
Base URL
https://api-gw.sendspark.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Sendspark Dynamics Campaign API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (apiKey). An API key is passed in the header as x-api-secret (apiSecret). By default, every request must be authenticated.

Paths & Operations 13

Across 12 paths, the API surfaces 13 operations — 4 GET, 3 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Dynamics Campaign 13
GET
/v1/workspaces/{workspaceId}/dynamics
Get the list of Dynamic Campaigns by workspace
getDynamicsList 9 params → 400404503
POST
/v1/workspaces/{workspaceId}/dynamics
Create Dynamics Campaign
postDynamics 1 param body → 200400403404503
GET
/v1/workspaces/{workspaceId}/dynamics/{dynamicId}
Get workspace dynamic campaign
getWorkspaceDynamics 2 params → 200400404503
GET
/v1/workspaces/{workspaceId}/dynamics/settings
Get dynamics settings
getDynamicsSettings 1 param → 200400404503
GET
/v1/workspaces/{workspaceId}/dynamics/{dynamicId}/prospects/{contactEmail}
Get prospect data from prospect email
getProspectDynamicsVideos 4 params → 200400404
POST
/v2/workspaces/{workspaceId}/dynamics
Create Dynamics Campaign for the DV by steps UI
postDynamicsV2 1 param body → 200400403404503
POST
/dv-v2/workspaces/{workspaceId}/dynamics/{dynamicId}/bulk
Generate videos for Dynamics Campaign prospect list
postDynamicsVideoBulk 2 params → 200400403404503
POST
/v1/workspaces/{workspaceId}/dynamics/{dynamicId}/bulk
Generate videos for Dynamics Campaign prospect list
postV1WorkspacesWorkspaceidDynamicsDynamicidBulk 2 params → 200400403404503
POST
/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospect
Add prospect to Dynamics Campaign and process video.
postV1WorkspacesWorkspaceidDynamicsDynamicsidProspect 2 params body → 200400403404503
POST
/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/bulk
Bulk add and process prospects to a dynamics campaign.
postDynamicsProspectsBulkModify 2 params body → 200400403404503
PATCH
/v2/workspaces/{workspaceId}/dynamics/{dynamicsId}
Persisting Prospect Lists
patchDynamicsModifyV2 2 params body → 200400403404503
PATCH
/v1/workspaces/{workspaceId}/dynamics/{dynamicId}/settings
Update settings in Dynamics Campaign
patchDynamicModifySettings 2 params body → 200400404503
PATCH
/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk
Bulk update prospect background URLs based on email domains.
patchDynamicsProspectsUrlsBulkUpdate 2 params body → 200400403404503

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are responsePayloadProspectSchema (29 properties), requestPayloadProspectSchema (16 properties), DynamicVideosGetProspectResponseSchema (16 properties), ResponseModifyDynamicsCampaignSchema (14 properties). Each schema is shown below with its type and property counts.

SharePage
object
6 properties
Model146
object
6 properties
RequestPayloadBulkUpdateProspectsUrlSchema
object
1 property 1 required
DynamicVideosGetProspectResponseSchema
object
16 properties
Forbidden
object
4 properties
object
array
Model57
object
buttons
array
LanguagesGetResponseSchema
object
3 properties 1 required
ResourcesStatus
object
Metadata
object
2 properties
Model148
object
2 properties
PlaceholdersGetResponseSchema
object
2 properties 2 required
ResponseDynamicModifySettingsSchema
object
payloadDepurationStrategy
string
fallbacks
array
responsePayloadProspectSchema
object
29 properties 1 required
validationDetails
array
Model139
object
2 properties
Model145
object
2 properties
ResourceNotFoundOrInvalidAccess
object
3 properties
RequestPayloadAddProspectsDynamicsCampaignsSchema
object
5 properties 1 required
requestPayloadProspectSchema
object
16 properties
MultivariableLanguagesGetResponseSchema
object
RequestPayloadBulkProspectsDynamicsCampaignsSchema
object
4 properties
Model138
object
2 properties
ResponsePayloadProspectList
array
ServiceUnavailable
object
3 properties
ResponseCreateDynamicsCampaignSchema
object
12 properties 8 required
webhookEvents
array
Model144
object
6 properties 1 required
videoProperties
object
1 property
Model170
object
2 properties
prospectList
array
ResponseModifyDynamicsCampaignSchema
object
14 properties 7 required
Model147
object
1 property
sharePage
object
6 properties
VideoProperties
object
1 property
dynamicSettingsGetResponseSchema
object
2 properties
ResponseDynamicsVideoAddSchema
object
Model101
object
Additional fields associated with the prospect
dynamicSettingsLanguagesGetResponseSchema
object
3 properties
videosAssets
array
Model222
object
12 properties
Fields
object
RequestParamsCreateDynamicsCampaignsSchema
object
1 property 1 required
RequestPayloadDynamicModifySettingsSchema
object
1 property
BadRequest
object
4 properties
prospectDepurationConfig
object
2 properties
Model149
object
13 properties 8 required
Model169
object
3 properties
placeholders
array
layout
string
ResponseBulkUpdateProspectsUrlSchema
object
2 properties 2 required
Model100
object
3 properties
Model221
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sendspark-dynamics-campaign-api-openapi.yml Raw ↑

Other APIs Sendspark publishes across the network.

Sendspark DVM Bundles API
Sendspark Webhook API
Sendspark Workspace API
Where this information came from

This is an independent, third-party profile of Sendspark Dynamics Campaign API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.