OrganizationDataCampaigns

Add a data campaign

Add a new data campaign to a data campaign dashboard

post/api/organizations/{organizationId}/campaigns

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/organizations/:organizationId/campaigns/post.ts
A function with typed inputs. Its response is checked against the schema.

organizationIdinteger required

Organization ID

idinteger

dataCampaignDashboardIdinteger required

createdstring date-time

namestring required

descriptionstring required

coordinatorUidsinteger[] required

List of user IDs that coordinate this campaign

logostring

datasetsstring[] required

pipelineIdsinteger[] required

projectIdsinteger[] required

successboolean required

Whether the operation succeeded

errorstring

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

dataCampaignIdinteger required

No recorded changes to this operation across all 1 revision of this API.