Add a data campaign

Add a data campaign

post

Add a new data campaign to a data campaign dashboard

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

organizationIdintegerRequired

Organization ID

Body

idintegerOptional

dataCampaignDashboardIdintegerRequired

createdstring · date-timeOptional

namestringRequired

descriptionstringRequired

coordinatorUidsinteger[]Required

List of user IDs that coordinate this campaign

logostringOptional

datasetsstring[]Required

pipelineIdsinteger[]Required

projectIdsinteger[]Required

Responses

200

OK

application/json

Responseall of

post

HTTPcURLJavaScriptPython

POST /v1/api/organizations/{organizationId}/campaigns HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 313

{
  "id": 1,
  "dataCampaignDashboardId": 1,
  "created": "2025-07-25T13:11:52.165Z",
  "name": "text",
  "description": "text",
  "coordinatorUids": [
    1
  ],
  "logo": "text",
  "queries": [
    {
      "name": "text",
      "dataset": "text",
      "query": "text"
    }
  ],
  "links": [
    {
      "icon": "text",
      "name": "text",
      "link": "text"
    }
  ],
  "datasets": [
    "text"
  ],
  "pipelineIds": [
    1
  ],
  "projectIds": [
    1
  ]
}

200

OK

{
  "success": true,
  "error": "text",
  "dataCampaignId": 1
}