Skip to main content
POST
/
api
/
organizations
/
{organizationId}
/
campaigns
/
{campaignId}
Update data campaign
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns/{campaignId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "dataCampaignDashboardId": 123,
  "name": "<string>",
  "coordinatorUids": [
    123
  ],
  "logo": "<string>",
  "description": "<string>",
  "queries": [
    {
      "name": "<string>",
      "dataset": "<string>",
      "query": "<string>"
    }
  ],
  "links": [
    {
      "icon": "<string>",
      "name": "<string>",
      "link": "<string>"
    }
  ],
  "datasets": [
    "<string>"
  ],
  "pipelineIds": [
    123
  ],
  "projectIds": [
    123
  ]
}
'
import requests

url = "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns/{campaignId}"

payload = {
"dataCampaignDashboardId": 123,
"name": "<string>",
"coordinatorUids": [123],
"logo": "<string>",
"description": "<string>",
"queries": [
{
"name": "<string>",
"dataset": "<string>",
"query": "<string>"
}
],
"links": [
{
"icon": "<string>",
"name": "<string>",
"link": "<string>"
}
],
"datasets": ["<string>"],
"pipelineIds": [123],
"projectIds": [123]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dataCampaignDashboardId: 123,
name: '<string>',
coordinatorUids: [123],
logo: '<string>',
description: '<string>',
queries: [{name: '<string>', dataset: '<string>', query: '<string>'}],
links: [{icon: '<string>', name: '<string>', link: '<string>'}],
datasets: ['<string>'],
pipelineIds: [123],
projectIds: [123]
})
};

fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns/{campaignId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dataCampaignDashboardId' => 123,
'name' => '<string>',
'coordinatorUids' => [
123
],
'logo' => '<string>',
'description' => '<string>',
'queries' => [
[
'name' => '<string>',
'dataset' => '<string>',
'query' => '<string>'
]
],
'links' => [
[
'icon' => '<string>',
'name' => '<string>',
'link' => '<string>'
]
],
'datasets' => [
'<string>'
],
'pipelineIds' => [
123
],
'projectIds' => [
123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns/{campaignId}"

payload := strings.NewReader("{\n \"dataCampaignDashboardId\": 123,\n \"name\": \"<string>\",\n \"coordinatorUids\": [\n 123\n ],\n \"logo\": \"<string>\",\n \"description\": \"<string>\",\n \"queries\": [\n {\n \"name\": \"<string>\",\n \"dataset\": \"<string>\",\n \"query\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"icon\": \"<string>\",\n \"name\": \"<string>\",\n \"link\": \"<string>\"\n }\n ],\n \"datasets\": [\n \"<string>\"\n ],\n \"pipelineIds\": [\n 123\n ],\n \"projectIds\": [\n 123\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns/{campaignId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dataCampaignDashboardId\": 123,\n \"name\": \"<string>\",\n \"coordinatorUids\": [\n 123\n ],\n \"logo\": \"<string>\",\n \"description\": \"<string>\",\n \"queries\": [\n {\n \"name\": \"<string>\",\n \"dataset\": \"<string>\",\n \"query\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"icon\": \"<string>\",\n \"name\": \"<string>\",\n \"link\": \"<string>\"\n }\n ],\n \"datasets\": [\n \"<string>\"\n ],\n \"pipelineIds\": [\n 123\n ],\n \"projectIds\": [\n 123\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/campaigns/{campaignId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataCampaignDashboardId\": 123,\n \"name\": \"<string>\",\n \"coordinatorUids\": [\n 123\n ],\n \"logo\": \"<string>\",\n \"description\": \"<string>\",\n \"queries\": [\n {\n \"name\": \"<string>\",\n \"dataset\": \"<string>\",\n \"query\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"icon\": \"<string>\",\n \"name\": \"<string>\",\n \"link\": \"<string>\"\n }\n ],\n \"datasets\": [\n \"<string>\"\n ],\n \"pipelineIds\": [\n 123\n ],\n \"projectIds\": [\n 123\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "error": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
integer
required

Organization ID

campaignId
integer
required

Body

application/json
dataCampaignDashboardId
integer
name
string
coordinatorUids
integer[]

List of user IDs that coordinate this campaign

description
string
queries
object[]
datasets
string[]
pipelineIds
integer[]
projectIds
integer[]

Response

200 - application/json

OK

success
boolean
required

Whether the operation succeeded

error
string

Optional error description (set if 'success' was false)