Initialize Windows enterprise configuration

POST

/v1/organizations/:organizationId/mdm/windows/enterprise/

Initialize Windows enterprise configuration

Required Permission: mdm.windows.enterprise.create

Initialize Windows device management enterprise configuration with domain settings and branding customization for organizational enrollment processes.

Request

Add parameter in 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

domain string optional

Domain identifier used for Windows device enrollment portal branding and management interface customization throughout the organization.

≤ 256 characters

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",
    "configuration": {
        "primaryColor": "string",
        "logo": "string",
        "contactEmail": "[email protected]",
        "contactPhone": "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

Domain identifier used for Windows device enrollment portal branding and management interface customization throughout the organization.

≤ 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-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$

store object optional

customDomain string optional

≤ 256 characters

branding object optional

logo string optional

≤ 256 characters

picture string optional

primaryColor any optional

configuration object optional

storageProvider string optional

Match pattern: ^[a-fA-F0-9]{24}$

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

5157

message string optional

WinEnterprise domain already exists

{
    "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"
    }
}