White Label Admin - Update organization

White Label Admin - Update organization

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

post

/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerrequired

Organization ID

innerOrganizationIdintegerrequired

Organization ID within the context of a white label

Body

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.

readmestring

Readme for the organization (in Markdown)

billableboolean

entitlementLimitsobject

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

experimentsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"entitlementLimits":{},"domain":"edgeimpulse.com","experiments":[null]}'

200

200

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

OK