Add a data campaign

Add a data campaign

post

Add a new data campaign to a data campaign dashboard

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

Body

idintegeroptional

dataCampaignDashboardIdintegerrequired

createdstring · date-timeoptional

namestringrequired

descriptionstringrequired

coordinatorUidsinteger[]required

List of user IDs that coordinate this campaign

logostringoptional

queriesobject[]required

linksobject[]required

datasetsstring[]required

pipelineIdsinteger[]required

projectIdsinteger[]required

Responses

application/json

all ofoptional

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-04-16T14:34:56.589Z",
  "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
}