Skip to main content
POST
/
api
/
integrations
/
submissions
Create Submission
curl --request POST \
  --url https://mm-midmarket-integrations-api-preview.azurewebsites.net/api/integrations/submissions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "assets": [
    {
      "blobPath": "550e8400-e29b-41d4-a716-446655440000/campaign-video.mp4"
    }
  ],
  "contextItems": [
    {
      "applyTo": "all",
      "blobPath": "660e8400-e29b-41d4-a716-446655440111/evidence.pdf",
      "contextType": "substantiation",
      "kind": "file",
      "mimeType": "application/pdf",
      "name": "evidence.pdf"
    }
  ],
  "name": "Summer Campaign Launch",
  "sidekickIds": [
    "3b2f766c-14e5-4d96-bcb1-dd1c963818ca"
  ],
  "tags": [
    {
      "applyTo": "all",
      "key": "Campaign",
      "value": "Summer"
    }
  ]
}
'
{
  "submissionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflowId": "<string>",
  "ablyChannel": "<string>",
  "assets": [
    {
      "assetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "versionGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "versionNumber": 1
    }
  ]
}

Authorizations

​
X-API-Key
string
header
default:sk_live_your_api_key_here
required

Workspace-scoped API key. Format: sk_live_{64 hex chars}

Query Parameters

​
simulationDelaySeconds
integer | null
Required range: 0 <= x <= 30

Body

application/json

Request model for creating a submission.

​
assets
AssetInput · object[]
required

Assets to include in the submission

Minimum array length: 1
​
sidekickIds
string<uuid>[]
required

Sidekick UUIDs to run for compliance checking. At least one is required — a submission with no sidekick has nothing to check.

Minimum array length: 1
​
name
string | null

Optional display name for the submission. Defaults to the first asset's filename if omitted.

Maximum string length: 120
​
tags
TagInput · object[]

Tags to apply to assets, referenced by key/value (found-or-created).

​
contextItems
ContextItemInput · object[]

Supporting files/links to attach to assets for the compliance review.

​
metadata
Metadata · object | null

Optional custom metadata

Response

Successful Response

Response model for submission creation.

​
submissionId
string<uuid>
required

Created submission ID

​
workflowId
string
required

Workflow ID (job tracking ID)

​
ablyChannel
string
required

Ably channel for real-time updates

​
status
enum<string>
required

Submission status

Available options:
uploading,
submitted,
queued,
processing,
complete,
failed,
partial
​
assets
AssetCreatedResponse · object[]
required

Created assets