Favicon

You are here: Home > API Reference > Windows > Windows Enterprise Creation > Update Windows enterprise configuration

PUT /organizations/:organizationId/mdm/windows/enterprise

Required Permission: mdm.windows.enterprise.update

Update Windows device management enterprise configuration modifying domain settings and branding customization while regenerating enrollment certificates if needed.

PUT
https://api.applivery.io/v1/organizations/{organizationId}/mdm/windows/enterprise
curl -X PUT "https://api.applivery.io/v1/organizations/{organizationId}/mdm/windows/enterprise" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "configuration": {
    "primaryColor": "string",
    "logo": "string",
    "contactEmail": "[email protected]",
    "contactPhone": "string"
  },
  "domain": "string"
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/mdm/windows/enterprise", {
  method: "PUT",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "configuration": {
      "primaryColor": "string",
      "logo": "string",
      "contactEmail": "[email protected]",
      "contactPhone": "string"
    },
    "domain": "string"
  }),
});

const data = await response.json();
import requests

response = requests.put(
    "https://api.applivery.io/v1/organizations/{organizationId}/mdm/windows/enterprise",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "configuration": {
        "primaryColor": "string",
        "logo": "string",
        "contactEmail": "[email protected]",
        "contactPhone": "string"
      },
      "domain": "string"
    },
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json
configuration object optional
Enterprise branding and contact configuration applied to enrollment portal and device management experiences ensuring consistent organizational identity.
primaryColor string optional
≤ 256 characters
logo string optional
contactEmail string optional
≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email
contactPhone string optional
≤ 256 characters
domain string required
FQDN for Windows device enrollment. Must be enterpriseenrollment.your-domain (subdomain enterpriseenrollment under your DNS zone), with CNAME pointing to the platform distribution proxy as for store custom domains.
≤ 256 characters
{
    "configuration": {
        "primaryColor": "string",
        "logo": "string",
        "contactEmail": "[email protected]",
        "contactPhone": "string"
    },
    "domain": "string"
}

Responses

200 Response application/json
status boolean required
data object required
id string required
Unique identifier for the Windows enterprise configuration entity enabling targeted operations and relationship tracking across the platform.
Match pattern: ^[a-fA-F0-9]{24}$
domain string required
FQDN for Windows device enrollment. Must be enterpriseenrollment.your-domain (subdomain enterpriseenrollment under your DNS zone), with CNAME pointing to the platform distribution proxy as for store custom domains.
≤ 256 characters
updatedAt string required
Timestamp of the most recent modification to the enterprise configuration tracking changes and updates for audit purposes.
createdAt string required
Timestamp when the Windows enterprise configuration was initially created establishing the baseline for all subsequent modifications and tracking.
organizationInfo object optional
Organization identity and branding information inherited from the parent organization context providing consistent presentation across all device interactions.
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 128 characters
slug string optional
≤ 128 characters · ≥ 3 characters · Match pattern: ^[a-z0-9][a-z0-9-]+[a-z0-9]$
store object optional
branding object optional
configuration object optional
createdBy string optional
Match pattern: ^[a-fA-F0-9]{24}$
{
    "status": true,
    "data": {
        "id": "string",
        "domain": "string",
        "updatedAt": "string",
        "createdAt": "string",
        "organizationInfo": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "store": {
                "customDomain": "string"
            },
            "branding": {
                "logo": "string",
                "picture": "string",
                "primaryColor": "string"
            },
            "configuration": {
                "storageProvider": "string"
            },
            "createdBy": "string"
        }
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5229
message string optional
WinEnterprise enrollment domain must use enterpriseenrollment.{your-domain}
{
    "status": false,
    "error": {
        "code": 5050,
        "message": "Feature not allowed for you billing plan"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}