Skip to main content
POST
/
api
/
organizations
/
{organizationId}
/
whitelabel
/
organizations
/
{innerOrganizationId}
White Label Admin - Update organization
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "logo": "<string>",
  "headerImg": "<string>",
  "name": "<string>",
  "experiments": [
    "<string>"
  ],
  "readme": "<string>",
  "billable": true,
  "entitlementLimits": {
    "totalStorage": 123,
    "computeTimePerYear": 123,
    "gpuComputeTimePerYear": 123,
    "numberOfProjects": 123,
    "numberOfUsers": 123
  },
  "contractStartDate": "2023-11-07T05:31:56Z",
  "domain": "edgeimpulse.com"
}'
{
  "success": true,
  "error": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

organizationId
integer
required

Organization ID

innerOrganizationId
integer
required

Organization ID within the context of a white label

Body

application/json

Only fields set in this object will be updated.

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

headerImg
string

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

name
string

New organization name.

experiments
string[]
readme
string

Readme for the organization (in Markdown)

billable
boolean
entitlementLimits
object
contractStartDate
string<date-time>

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

domain
string

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 - application/json

OK

success
boolean
required

Whether the operation succeeded

error
string

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

I