White Label Admin - Update organization

White Label Admin - Update organization

White label admin only API to update organization properties such as name and logo.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Body

application/json

logostring

New logo URL, or set to null to remove the logo.

headerImgstring

New leader image URL, or set to null to remove the leader.

namestring

New organization name.

experimentsarray of string

readmestring

Readme for the organization (in Markdown)

billableboolean

entitlementLimitsEntitlementLimits (object)

contractStartDatestring (date-time)

The date in which the organization contract started. Compute time will be calculated from this date.

domainstring

The domain of the organization. The organization domain is used to add new users to an organization. For example, new @edgeimpulse.com would be added to the Edge Impulse organization if this organization has edgeimpulse.com as the domain.

Example: "edgeimpulse.com"

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}